First approach to Github Projects guidelines documentation #29
Conversation
aitbw
changed the title
|
|
||
| ## General notes | ||
|
|
||
| ### Some rules first about the project |
There was a problem hiding this comment.
I think it would be better if this was something like General rules for projects
| - Use Todo lists (this can help to better define the scope of an issue | ||
| and the state of it). | ||
| - Please try not to create huge issues, make them as short and clear | ||
| scoped as possible. If you need some sort of complex issue, please |
There was a problem hiding this comment.
@aitbw Why do you say it is slipped?
There was a problem hiding this comment.
Never heard of short and clear scoped before
| and the state of it). | ||
| - Please try not to create huge issues, make them as short and clear | ||
| scoped as possible. If you need some sort of complex issue, please | ||
| brake it down into smaller pieces. |
|
One final change, @vctr90: Could you please move this file to this folder? There's an empty file there especially for this document Other than that, I agree with this draft 😄 |
|
@aitbw Please review again. Thanks. |
|
Please, include this document here or delete that file to avoid duplicates 😌 |
|
Done @aitbw |
| 2. Every single pull request MUST be associated with a GitHub issue | ||
| 3. Whenever you close a pull request or comment on an issue, please | ||
| make sure to agree on issue completion. | ||
| 4. All issues should have a deliverable product (a document or a |
There was a problem hiding this comment.
This is not consistent with our current DO NOT REMOVE issues. Let’s rephrase this to be relative to the Publication-N repos and not the meta repo.
There was a problem hiding this comment.
@sadasant When I say "deliverable product", I mean, a generic way to give a "tangible" solution for an issue, the issue could be related or not to a publication. For example, this is not a document considered as TecnoYucas publication, therefore, it is just a guideline document, a "deliverable product" of this issue. What I can do is to put a note that states that a "Deliverable product" could also be a Publication-N.
I am guessing TecnoYucas will be wider than just publications. We will be doing things not related to publications. For example: A merged feature, is a "deliverable product" of an issue but as you know, it does not have necessarily be a publication-related issue.
There was a problem hiding this comment.
Yes! I understand that, I think. However, we have created issues that have no deliverables, which are our DO NOT REMOVE issues. We use them as a place to communicate. These issues were created with the goal of not removing them for now. What are your thoughts around that?
|
|
||
| 1. When an issue is newly created, it will directly go into `Inbox | ||
| (Not approved yet)` column | ||
| 2. After an issue is approved (by at least **two** members of the |
There was a problem hiding this comment.
we can automate this if we use waffle instead of github projects and treat the boards to use labels, so an issue can go from Inbox to To do (Approved) as soon as someone assigns him/herself to the issue.
There was a problem hiding this comment.
Cool, I can investigate and set a project in Waffle, what do you think @sadasant ?
There was a problem hiding this comment.
I haven't used Waffle, but Github Projects have something similar: https://help.github.com/articles/configuring-automation-for-project-boards/
There was a problem hiding this comment.
Yes! Well, essentially: all of the columns should be automated based on tags, once we do that, I'll be comfortable with having rules around this. None of this process should be manual (except for some of the issue assignment at least)
I think this pretty much fits what This is a very widespread practice, to not call it standard, that helps newcomers discover valuable information about the project. |
Hi @tecnoyucas/yucazos
This PR seeks to solve #10 Issue about GitHub projects guidelines.
Please review this pull request and also let's discuss about this document. You might want to suggest some changes or new flows, I'm all ears 😄
Thanks.