docs(contributing): add Contributing Guide#75
Conversation
Took the challenge guide from the main repo and reworked it for the Curriculum repo. Moved the CONTRIBUTING.md file to the root directory. Added an image directory and sample image to more clearly show how to open a PR and point it to the correct branch, like in the guide in the main repo. ISSUES CLOSED: freeCodeCamp#61
There was a problem hiding this comment.
Lets keep the guide in docs. On the main repo we can't move it around because its linked from several places. But here lets keep the documentation in docs. This repo is relatively new. And hence should be structured carefully.
Don't worry GitHub will still pick up the correct file from its referencing on issues and PRs.
raisedadead
left a comment
There was a problem hiding this comment.
Okay, lets just get this in and keep enhancing from there. Its better to have something in right away.
|
@raisedadead, sorry! I didn't see your response and went to bed. Thank you for making those changes. I'll keep that all in mind for the future. |
|
@scissorsneedfoodtoo oh yes no worries. I was in a rush. I have gone ahead and fixed up a lot of the PR commit messages. The release QA workflow is being documented. But here is the thumb rule:
However while using |
|
Under no circumstances we should see a description that has a And as for the release itself it should be fast forwarded commits into I am documenting this more precisely. Will update you soon. |
|
But for now, feel free to QA and merge the PRs. I should have updated all of them for you. |
|
@raisedadead, sorry about all the errors before--didn't mean to create more work for you! I was surprised to see the version numbers going up so quickly on npm. Hopefully with these rules in place the bumps will be small and predictable. Will definitely be on the lookout for anything that says Just a quick question: For rule number 2 above, I would just delete everything in the description box, so all the asterisks, and just make sure the commit message is in the correct format. By correct format, is that just making sure the commit message was written using |
Pre-Submission Checklist
stagingbranch of freeCodeCamp.fix/,feature/, ortranslate/(e.g.fix/signin-issue)npm test. Usegit commit --amendto amend any fixes.Type of Change
Checklist:
Closes #61
Description
Took the challenge guide from the main repo and reworked it for the Curriculum repo. Moved the
CONTRIBUTING.md file to the root directory. Added an image directory and sample image to more
clearly show how to open a PR and point it to the correct branch, like in the guide in the
main repo.