Hi Piotr, as you requested, I'm compying from other threads what I think it's the best proven workflow to work (as I saw it in many projects):
I think what Piotr propose is very good for organization, revision and matching with issues. The workflow I know (and I think works pretty well) is the following. Notice that this method tries to always develop in branches and ensures develop is always stable and green. That should be our mantra, and people coming to Royale should recognize a good methodology of development like other well stablished projects out there. 1.- we should have an issue number (i.e: [#<issuenumber] <commit description>) and as we try to solve it create a branch "feature/<issuenumber> <friendly_branch_name_for_easy_recognition_optional>" 2.- As we end developing, we must ensure the change does not break develop, so in local you can merge and test it. 3.- If all goes ok, you can push the changes and remove the "feature/<issuenumber>" this creates a good git graph that is easy to follow. If we use rebase as well all is very organized and easy for people try to follow the development. As all commits from a issue has [#<issuenumber], it's easy to see the match between commits and issue easy. We should avoid to commit directly to develop, in general is a bad practice. That's what I see in IT projects, and what works in great way. Best Carlos 2017-10-04 4:49 GMT+02:00 Piotr Zarzycki <[email protected]>: > Hi Guys, > > I thought that would be could to share some vision about how could we work > with our GitHub repository. > > COMMITS: > This parts is only regards when we have issue raised. Each commit should > have description and issue number. I will use as an example our issue > raised for renaming. [1] > > If you commit to royale-asjs: > > "My commit message (reference #17)" > > If you commit to royale-compiler, but it is related to issue from > royale-asjs: > > "My commit message (reference apache/royale-asjs#17)" - That format allow > us to see commit under issue in royale-asjs repo :)) > > We can use here also some keywords [2]. > > LABELS: > Let's use available labels to sort out with what kind of issue we have to > deal. [3] We can introduce some new labels. > > VERSIONING: > This part is definitely to some discussion in case of "bugs". We should > definitely use "Milestones" for that purpose. I've created two milestones > for royale-asjs [4] and royale-compiler. I have marked our issue for > renaming [1] which means that will be released in Royale 0.9.0. > The question is if we have bug - how can we mark in which version it occurs > ? Maybe we should create special milestones ? > > ISSUES IN PROGRESS: > I have created projects [5][6]. If you would like to tell some folks on > what are you actually working or what will be - the projects is the place > where you could do that. Just move your issue to To Do/In Progress column. > > Please share your thoughts about that, feel free make the changes. :) > > [1] https://github.com/apache/royale-asjs/issues/17 > [2] https://help.github.com/articles/closing-issues-using-keywords/ > [3] https://github.com/apache/royale-asjs/labels > [4] https://github.com/apache/royale-asjs/milestones > [5] https://github.com/apache/royale-asjs/projects/2 > [6] https://github.com/apache/royale-compiler/projects/1 > > Thanks, > Piotr > -- Carlos Rovira http://about.me/carlosrovira
