Add contributor guide to GitHub's interface
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
Let's make our contributor guide visible to GitHub's interface by following these instructions: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.
We have a docs directory due to the nature of our repository. We can put the contributor guide at docs/CONTRIBUTING. This may require dropping the .md suffix. If so, we'll want to keep the content in its original location and provide links to relevant sections using an FAQ style.
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.
Research direction
Start by reading GitHub's contributor-guideline instructions and inspecting the existing contributor guide and docs/ directory. Determine whether docs/CONTRIBUTING should omit the .md suffix while preserving the original content location. Done means GitHub displays the contributor guide and the relevant FAQ sections link correctly to the original content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100