Collate information on contributing to the project into a single source of truth.
- Dominant language
- JavaScript
- Stars
- 35.8k
- Forks
- 4.1k
- Avg merge
- 2d 26m
- Merged PRs (30d)
- 33
Description
As noted in #2333, information on how to contribute to the project is split over
- the wiki ['Contributing'](https://github.com/gchq/CyberChef/wiki/Contributing) page
- the main project [README.md](https://github.com/gchq/CyberChef/blob/master/README.md#contributing)
- the main project [CONTRIBUTING.md](https://github.com/gchq/CyberChef/blob/master/CONTRIBUTING.md)
This leads to duplication of information and updates getting out of sync.
The information should be collated into a single place and the other locations either removed or changed to a simple link to the main source of truth.
Contributor guide
Research direction
Compare the wiki Contributing page, the contributing section of README.md, and CONTRIBUTING.md to identify duplicated and conflicting information. Consolidate the guidance into one source of truth and replace the other locations with links; done means contributors can find the same current instructions without duplication.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100