freedomofpress / freedomofpress/securedrop-dev-docs
Reorganize contributor guidelines to help new contributors get started
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 1
Description
Describe the change
The contributor guidelines at https://developers.securedrop.org/en/latest/contributor_guidelines.html are exhaustive but not ordered to be useful as a guide for new contributors to get started. At the very least, it would be helpful for them to refer folks to the relevant sections in the documentation on setting up environments. Ideally they should present a quickstart guide first, with the information on coding standards and project conventions coming after and presented in a more structured manner,
Contributor guide
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.
Research direction
Read the contributor guidelines at the linked documentation page and review the sections covering environment setup. Reorganize the page so new contributors see a quickstart and setup references first, followed by structured coding standards and project conventions. Done means the guidance has a clear onboarding order.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100