-
Notifications
You must be signed in to change notification settings - Fork 155
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
Comments
What should be in this contributing document? One big thing I can think of is this.
|
That sounds good but I also thought like guidelines for making a pull
request.
…On Fri, 20 Mar 2020, 15:32 Benjamin Cross, ***@***.***> wrote:
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.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#23 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AJOQ33GNCPUQSYPGTWDVFVLRIN47TANCNFSM4LQM2BHA>
.
|
Here are some useful tips: link.
Suggestions? Also ideas on other forms of contribution ie documentation, issue gardening etc.? |
Could you make a pull request with a contributing file?
…On Fri, 20 Mar 2020, 16:03 Benjamin Cross, ***@***.***> wrote:
Here are some useful tips: link
<https://www.atlassian.com/blog/git/written-unwritten-guide-pull-requests>
.
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
<https://chris.beams.io/posts/git-commit/>
- 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.?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#23 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AJOQ33BKDAFPYOQFIVQHUNDRIOAU3ANCNFSM4LQM2BHA>
.
|
Yeah absolutely. Though now I am concerned it won't be up to par... |
@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. |
Add a "CONTRIBUTING" file that explains how to contribute to the project.
The text was updated successfully, but these errors were encountered: