Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.46 KB

Anyone is welcome to contribute new specifications or collaborate on existing documents, in accordance with the C2SP Code of Conduct and the relevant licenses.

Note that when contributing to a certain specification, its maintainers are responsible for accepting or rejecting changes, and different maintainers may have different preferences for contributions.

New specifications

New specifications are approved by a quorum of two stewards and assigned to one or more maintainers.

If you wish to maintain a new spec, open an issue with a New spec: prefix. The specification proposal must include:

  • A description of the specification sufficient to assess its scope. A draft is useful but not required.

  • The proposed short name matching the regex [a-zA-Z0-9\-]+. This will become part of its URL (e.g. https://c2sp.org/short-name).

  • The proposed maintainers.

  • The text /cc @C2SP/stewards

See #45 for an example.

Tagging new versions

To tag a new version, a maintainer creates a file named <spec-name>/.new-tag (e.g. age/.new-tag) with the following contents:

v1.2.3
<full 40-character commit hash>

The first line is the version (a valid semver like v1.2.3), and the second line is the full commit hash to tag. The commit must be reachable from the main branch.

Merge this file to main, and a GitHub Action will create the tag <spec-name>/v1.2.3 and remove the .new-tag file.