spdx / spdx/cryptographic-algorithm-list

Add syntax and grammar rules for the IDs

Open
#83 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
No language data
Stars
8
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Background

Currently the syntax and grammar rules are inferred from the License list or there are no rules.

Rationale

Just like the License List did, we need to create such rules for consistency and to propose/agree on new IDs corresponding to algorithms to be included on the CryptAlg List.

Description

Actions

DoD

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how syntax and grammar rules are handled in the License List and how IDs are used in the CryptAlg List. Define and document the agreed rules for existing IDs and proposed algorithm IDs, then complete the issue's Actions and DoD sections so the result can be reviewed for consistency.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.