Add documentation on GitHub tokens and secrets to contribution guidelines
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 3
Description
Since we're relying more and more on tokens and secrets, we should probably add a documentation section to the contribution guidelines where to find the information on these
Originally posted by @mberz in https://github.com/pyfar/template-pyfar-package/issues/60#issuecomment-4258501495
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
First locate the repository's contribution guidelines and review the existing documentation structure. Add a section explaining where contributors can find information about GitHub tokens and secrets; it is done when the guidance is clear and included in the contribution guidelines.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100