Improve README.md #745
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
priority/low
Nice to have
Improve documentation
Link
https://github.com/ooni/explorer#readme
Describe the problem
In the perspective of a new contributor, the
README.md
provided seems to be very basic for setting up the project. So it would be good, if we have aCONTRIBUTING.md
that covers all aspects of setting up the project locally and contributing.Describe the improvement
I think we should have
CONTRIBUTING.md
doc for the project and few things that we can include are:these are things that i have currently in my mind and it can extend to other project oriented things as well.
The text was updated successfully, but these errors were encountered: