docs: add contributing.md file #60
Conversation
| ## We Develop with Github | ||
| We use github to host code, to track issues and feature requests, as well as accept pull requests. | ||
|
|
||
| ## All Code Changes Happen Through Pull Requests |
There was a problem hiding this comment.
This file is using all h1 and h2 headings. if you consider We Develop with Github is an h2, this should be an h3, as it is related to developing within Github. so use
### All Code Changes Happen Through Pull Requests
There was a problem hiding this comment.
Actually I'd suggest removing entirely the "We Develop with GitHub" section; they need to find the GitHub repo to see this, so it's self-evident 😛
There was a problem hiding this comment.
Yeah fair point 😅 . I'll remove the section entirely
| 5. Make sure your code lints. | ||
| 6. Issue that pull request! | ||
|
|
||
| ## Any contributions you make will be under the MIT Software License |
| ## Any contributions you make will be under the MIT Software License | ||
| In short, when you submit code changes, your submissions are understood to be under the [LICENSE](/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. | ||
|
|
||
| ## Report bugs using Github's [issues](https://github.com/teachaccess/tutorial/issues) |
| ## Report bugs using Github's [issues](https://github.com/teachaccess/tutorial/issues) | ||
| We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/teachaccess/tutorial/issues/new); it's that easy! | ||
|
|
||
| **Great Bug Reports** tend to have: |
There was a problem hiding this comment.
make this an h4, as it relates to the H3 about reporting bugs
|
|
||
|
|
||
|
|
||
| ## License |
|
|
||
| ## We Develop with Github | ||
| We use github to host code, to track issues and feature requests, as well as accept pull requests. |
There was a problem hiding this comment.
| ## We Develop with Github | |
| We use github to host code, to track issues and feature requests, as well as accept pull requests. |
| ## Any contributions you make will be under the MIT Software License | ||
| In short, when you submit code changes, your submissions are understood to be under the [LICENSE](/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. | ||
|
|
There was a problem hiding this comment.
I'd also suggest removing this section. The goal of contributing.md is to inform contributors about technical aspects of the contribution process, whereas LICENSE serves to inform the dev about the legal aspects. If we include too much info that's not immediately relevant, I'm afraid contributors won't read the guidelines in full. See examples of other high-traffic open-source contributing.md, like Prettier and cypress
There was a problem hiding this comment.
Also, this repo isn't licensed under MIT. It's licensed under Creative Commons
| - A quick summary and/or background | ||
| - Steps to reproduce | ||
| - Be specific! | ||
| - Give sample code if you can. | ||
| - What you expected would happen | ||
| - What actually happens | ||
| - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
There was a problem hiding this comment.
This would be better located in an issue template
| ### CONTRIBUTING | ||
|
|
||
| This project is a community effort and lives off your contributions, be it in the form of bug reports, feature requests, discussions, or fixes and other code changes. Please refer to our organization's [contributing guidelines](CONTRIBUTING.md) if you are interested to contribute. |
There was a problem hiding this comment.
It seems like this section belongs to the README, not the contributing guidelines?
|
@sarthakgupta072 thank you for your contribution, I see you put a lot of care and dedication into this. After reviewing I've realized that we should have been more clear on what we're seeking in the contribution guidelines. In hindsight, I think this task should be carried out by the maintainers. For this reason I'm closing the PR but marking it as |
|
Sure thanks @rachelruderman. I understand, Thanks for putting the label though 😄 |
Add CONTRIBUTING.md file
Fix #5
Please let me know if any changes are required. 😄