spdx / spdx/cryptographic-algorithm-list
Create an intro text for the List
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 8
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Background
The SPDX Cryptographic Algorithm List might be referenced by different SPDX profiles so there is a need for an introduction text, in the line of the License List, that can be used by those profiles.
Rationale
This introductory text should be short and to the point. USe the SPDX License List as reference.
Description
The introduction text should include
- Inspired by the License List reference
- what is it
- What is for
- Link to the repo
Actions
- Create an introduction content draft
- Discuss the draft during a meeting
- When agreed, create a PR
- Review and merge the PR
DoD
- Link to the draft
- Approved within the meeting, until we create our own mailing list
- Link to the PR:
- Link to the final introduction
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
Open the draft linked in the issue comments and compare it with the SPDX License List introduction, which is named as the reference. Create the agreed short introduction with what the Cryptographic Algorithm List is for and a repository link, then open a PR and update the issue with links to the PR and final introduction.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100