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

[Documentation] Add a "CONTRIBUTING" file #23

Closed
AlbertCoolGuy opened this issue Mar 20, 2020 · 6 comments
Closed

[Documentation] Add a "CONTRIBUTING" file #23

AlbertCoolGuy opened this issue Mar 20, 2020 · 6 comments

Comments

@AlbertCoolGuy
Copy link
Contributor

Add a "CONTRIBUTING" file that explains how to contribute to the project.

@BenjaminCCross
Copy link
Contributor

What should be in this contributing document? One big thing I can think of is this.

  • When making a pull request, reference a specific issue. If there is no specific issue then make one. This will allows to keep track of issues as well as see growth and change.

@AlbertCoolGuy
Copy link
Contributor Author

AlbertCoolGuy commented Mar 20, 2020 via email

@BenjaminCCross
Copy link
Contributor

Here are some useful tips: link.
More specific ideas:

  • When making a pull request include the number of the issue in the title.
  • Use clear and succinct commit messages. Useful but long guide: link
  • Keep your pull request to one issue. Smaller is better.
  • When describing the bull request don't assume past history with the issue.
  • If you need help please include areas of concern to help reviewers know what they can do.
  • add screen shots if you are including visual changes
  • @mention devs that you specifically want to see the PR and mention why. Such as having experience with the issue.

Suggestions? Also ideas on other forms of contribution ie documentation, issue gardening etc.?

@AlbertCoolGuy
Copy link
Contributor Author

AlbertCoolGuy commented Mar 20, 2020 via email

@BenjaminCCross
Copy link
Contributor

Yeah absolutely. Though now I am concerned it won't be up to par...

@BenjaminCCross
Copy link
Contributor

@AlbertCoolGuy @KalleHallden this issue can be closed after the merge. I can't close it for some reason, but as admin or the person who opened it one of you can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants