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 guidelines #11

Open
chippmann opened this issue Feb 7, 2020 · 0 comments
Open

Add contribution guidelines #11

chippmann opened this issue Feb 7, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@chippmann
Copy link
Contributor

chippmann commented Feb 7, 2020

Describe the problem or limitation you are having in your project:
We should define some contribution guidelines to streamline the development process between contributors.
It definitely should include sections about how to branch and write commit messages.

Describe how this feature / enhancement will help you overcome this problem or limitation:
It would make the development more consistent and the commit messages more meaningful. It also would help new contributors to get started more easily.

Show a mock up screenshots/video or a flow diagram explaining how your proposal will work:
None to provide

Describe implementation detail for your proposal (in code), if possible:
As a starting point:
@piiertho and I settled down for git flow as on how to manage branches and write commit messages: https://danielkummer.github.io/git-flow-cheatsheet/ (ignore the plugin, it is not needed)
Rest (and maybe also this one) can be discussed further.

If this enhancement will not be used often, can it be worked around with a few lines of code?:

Is there a reason why this should be in this project and not individually solved?:
As it concerns all contributors the guidelines should be in this project.

@chippmann chippmann added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant