Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contribution/branching guide #40

Open
runegan opened this issue Sep 8, 2017 · 2 comments
Open

Add contribution/branching guide #40

runegan opened this issue Sep 8, 2017 · 2 comments

Comments

@runegan
Copy link
Member

runegan commented Sep 8, 2017

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


For future contributors…

@runegan
Copy link
Member Author

runegan commented Sep 8, 2017

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
Copy link
Member Author

runegan commented Sep 8, 2017

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 runegan added this to the 1.0 Release milestone Feb 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant