aequery icon indicating copy to clipboard operation
aequery copied to clipboard

Add contribution/branching guide

Open runegan opened this issue 8 years ago • 2 comments

Original report by Remco Janssen (Bitbucket: [Remco Janssen](https://bitbucket.org/Remco Janssen), ).


For future contributors…

runegan avatar Sep 08 '17 13:09 runegan

Original comment by Rune Gangsø (Bitbucket: runegan, GitHub: runegan).


Good idea!

What should be included in the guide? What is normally there?

I guess there should be a note about develop being the default branch, and master is only used for release/stable versions.

Also:

  • When to use Pull Requests
  • When to create issues

runegan avatar Sep 08 '17 15:09 runegan

Original comment by Remco Janssen (Bitbucket: [Remco Janssen](https://bitbucket.org/Remco Janssen), ).


Yes exactly! It doesn't have to be long.

It should also state we use the git flow model. We can explain the main points of it and link to more info. I like this one as it's visual and shows examples: https://www.atlassian.com/git/tutorials/comparing-workflows#gitflow-workflow

Other points are:

  • Coding style & ESLint
  • Choosing the right module
  • Build process

Examples:
https://github.com/jessesquires/HowToContribute https://github.com/codemirror/CodeMirror/blob/master/CONTRIBUTING.md

runegan avatar Sep 08 '17 16:09 runegan