Fix Issue #15, created Contributing.md #16
Conversation
Create CONTRIBUTING.md
There was a problem hiding this comment.
Great work @CometS1
Only suggestion is adding a link to Contributing.md at the end of the README.md
|
Updated Readme for contributing link |
There was a problem hiding this comment.
Thank you for your first contribution @CometS1! 🎊
CONTRIBUTING.md helps new individuals get up and running more easily, as well as find help if they need it. We're excited to land this 🙉
We love what you've done and have a few suggestions to make this even better. Please don't hesitate to let us know if you have any questions!
CONTRIBUTING.md
Outdated
| ### Running the app | ||
|
|
||
| ``` | ||
| $ npm install |
There was a problem hiding this comment.
We should consider the vast range of individuals who might want to contribute - some of them might not be familiar with what each command does 🤔
Could we add a brief comment beside each command like so:
$ npm install # install required packages for creative collab
$ npm start # start creative collab at localhost:3000
CONTRIBUTING.md
Outdated
| Please use the [Issue Tracker](https://github.com/Mera-Gangapersaud/Creative-Collab/issues) to discuss | ||
| potential improvements you want to make before sending a Pull Request. | ||
|
|
||
| The Issue Tracker may contain items labelled **help wanted** or **good first issue** |
There was a problem hiding this comment.
❤️ this! We actually use the label good first bug 🐛 instead of good first issue - would you be able to swap those out?
It would also be sweet to link individuals directly to those issues, like so:
[**good first bug**](https://github.com/Mera-Gangapersaud/Creative-Collab/labels/good%20first%20bug%20%F0%9F%90%9B)
[**help wanted**](https://github.com/Mera-Gangapersaud/Creative-Collab/labels/help%20wanted%20%F0%9F%99%8F%F0%9F%8F%BC)
|
|
||
| ## Pull Requests | ||
|
|
||
| [Pull Requests](https://help.github.com/articles/about-pull-requests/) are used for contributions. Code must be well-tested and not decrease the test coverage significantly. |
CONTRIBUTING.md
Outdated
| Please commit changes to a separate branch in your fork | ||
| so that we can work together making changes to it before it | ||
| is ready to be merged. Name your branch something like | ||
| `<username>/feature`. |
There was a problem hiding this comment.
Thank you very much for this! It might be better to have contributors name their branches after the issues they're fixing, like so:
username/issue-X where X is the issue number their pull request addresses
README.md
Outdated
| ``` | ||
|
|
||
| ### Contributing | ||
| Please see the Contributing [guidelines](CONTRIBUTING.md) |
There was a problem hiding this comment.
nit: Let's add a period like so:
Please see the Contributing [guidelines](CONTRIBUTING.md).
README.md
Outdated
| ### Running the app | ||
| You must have these or a later version installed: | ||
|
|
||
| Node version 10.10 | npm version 6.4.1 |
There was a problem hiding this comment.
Nice - just to make it easier to read, could we update this to a bulleted list, like so:
- Node.js version 10.10
- npm version 6.4.1
To get that look, we'd need to do something like:
* Node.js version 10.10
* npm version 6.4.1
Made minor changes to Contributing doc
Made minor changes to Readme
|
Updated docs for minor changes. |
CONTRIBUTING.md
Outdated
|
|
||
| Please commit changes to a separate branch in your fork | ||
| so that we can work together making changes to it before it | ||
| is ready to be merged. Name your branch something like |
There was a problem hiding this comment.
Oversight on my part - when an individual forks Creative Collab, it won't be Mera-Gangapersaud/Creative-Collab but Username/Creative-Collab.
With the current instructions, users will be creating their branches like so:
git checkout -b username/issue-999
instead of:
git checkout -b issue-999
Could we update this to:
Branch names should follow the format of issue-X, where X is the issue number that your pull request fixes.
|
Updated for branch names |
There was a problem hiding this comment.
Thank you for the quick turn-around @CometS1! We look forward to seeing you help develop Creative Collab into something spectacular 🥇✨
Created Contributing.md and added into the README basic instructions to run the app.