canonical / canonical/operator
Condense and remove redundancy in CONTRIBUTING.md
Open
Beginner friendly
rainy day
- Dominant language
- Python
- Stars
- 267
- Forks
- 136
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 28
Description
Now that we've merged HACKING.md with CONTRIBUING.md (https://github.com/canonical/operator/pull/2734), there's some duplicative content, and I believe it could also go on a diet (trim some of the overly verbose content, remove "obvious" things, and so on).
Contributor guide
Research direction
Read CONTRIBUTING.md and review the HACKING.md merge in pull request #2734 to identify duplicated material. Trim verbose or obvious guidance while preserving the useful contribution instructions; done means the document is shorter, non-redundant, and still covers the needed contributor information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100