search

jqlang / jq

Command-line JSON processor
https://jqlang.github.io/jq/
Other
29.56k stars 1.54k forks source link

Contributing Documentation - Specifically for First-Timers #1921

Open esotericwarrior opened 5 years ago

esotericwarrior commented 5 years ago

Hello!

While evaluating this project's software inclusiveness as part of an assignment for an Open Source CS class, I noticed that there was no documentation for contributing to this project. This can be a little discouraging for first-time contributors that would like to get involved, but may not have any idea where to begin. While there is a link to the "Open Source Guide" when navigating to the Issues tab, this guide is a very broad guide about Open Source projects in general and doesn't specifically point to anything related to this project.

I think including a document, such as a CONTRIBUTING.md, or even adding a "Contributing" section to the README with detailed instructions on how first-time and experienced users alike might benefit the project in the long-term. Including information such as fixing existing issues, sharing an idea for the project, reporting issues with the software, or contacting other users for additional information could be useful, while also encouraging beginners to contribute.

nicowilliams commented 5 years ago

Hmm, OK, we'll add something.

We do have an extensive wiki with lots of details on the internals of jq, if that's what you're looking for, and that's what any CONTRIBUTING.md would link.

As to process, it's easy: send us a PR.