Improve README.md
Open
@majakomel is already working on this.
Since Apr 6, 2023.
docs
good first issue
- Dominant language
- JavaScript
- Stars
- 92
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Description
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 a CONTRIBUTING.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:
- pointer to OONI Software Development Guidelines
- any helpful resources for getting started with the project
- specify how to open an Issue or Pull Request using one of our templates
- mention how to start contributing
- direction to reach us, if they have trouble in the setting up of the project
these are things that i have currently in my mind and it can extend to other project oriented things as well.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.