Add a terminology page in Macaron documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 210
- Forks
- 36
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 2
Description
Someone who is new to Macaron or to the topic of supply-chain security as a whole may not be familiar with all of the terms that we use. A terminology page will be helpful to people.
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
Start by reviewing the existing Macaron documentation and the terminology used across the project. Identify where a terminology page belongs and which supply-chain security terms need explanation; done means the new page is discoverable and gives newcomers clear definitions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100