Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md #745

Open
thara003 opened this issue Apr 15, 2022 · 0 comments
Open

Improve README.md #745

thara003 opened this issue Apr 15, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority/low Nice to have

Comments

@thara003
Copy link
Contributor

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.

@thara003 thara003 changed the title Improve developer doc Improve README.md Apr 15, 2022
@hellais hellais added documentation Improvements or additions to documentation priority/low Nice to have good first issue Good for newcomers labels May 2, 2022
@hellais hellais added this to Roadmap Jan 7, 2025
@hellais hellais removed this from Roadmap Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority/low Nice to have
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants