-
Notifications
You must be signed in to change notification settings - Fork 2
Update CONTRIBUTING.md #32
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
Conversation
ashstewart7
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome - just a couple tiny suggestions/things for discussion :)
| - If you become a regular contributor, you may request to be added as a collaborator on the project so that you can work from a direct clone rather than a fork. | ||
| - Name your feature branch something descriptive of your task. Including the issue number is common practice. | ||
| - For example, if you are working on issue number 42 and performing a refactor on the navbar component, a good branch name would be `42-refactor-navbar-component`. | ||
| - Ensure that your code works, tests pass and your code is properly linted and formatted prior to opening a PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be worth adding that, once a PR is created and the user is happy with it, to formally request review from @\CodeCafeCommunity/website?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or create a discord channel specifically for contributors. And assign a role only when someone has actively taken on an issue. I don't know if that can be done with an automatic process.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ooh neat, I think we'd probably have to do it manually, but I agree with having a channel.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I definitely like the idea of having a dedicated channel and Contributor role in the discord server! I think maybe they should receive the role after having a PR merged in. Once we have that set up we can add a section about it to this document
ashstewart7
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
What issue is this solving?
Closes #29
Description
Add initial contribution guidelines for all contributors, as well as maintainers.
Any helpful knowledge/context for the reviewer?
Feelings gif (optional)
What gif best describes your feeling working on this issue? https://giphy.com/

How to embed:
Please make sure you've attempted to meet the following coding standards