Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Add Commenting Guidelines to CONTRIBUTING.md #1354
Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.
If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open-source software!
We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you
If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!
What is to be done?
We are working towards standardizing all the comments in the codebase to make the docs look professional. One of the main steps towards this would be to add some guidelines to the CONTRIBUTING.md file. Some guidelines are listed below (you can add your own too if you feel it is necessary)