Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add English as normative notes #1170

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 42 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,31 @@ the software supply chain. SPDX reduces redundant work by providing a common
format for companies and communities to share important data about software
licenses and copyrights, thereby streamlining and improving compliance.

## Specification development
Current stable version:

The specification is comprised of documents located in the `docs/` directory
of this `spdx/spdx-spec` repository, as well as a model documentation
generated from Markdown files within the
[spdx/spdx-3-model](https://github.com/spdx/spdx-3-model/) repository.
- The current stable specification is available at:
<https://spdx.github.io/spdx-spec/>

Next version (work in progress):

- A preview of the next version, currently under active development, is
available at:
<https://spdx.github.io/spdx-spec/develop/>
(This website is automatically updated with each commit to the `develop`
branch).

This `spdx/spdx-spec` repository holds under active development version
of the specification as:
Translations of the specification may be available.
English remains the normative language in all cases.

- Markdown:
[`development/v3.0.1`](https://github.com/spdx/spdx-spec/tree/development/v3.0.1/docs)
branch
- HTML: `gh-pages` branch, built on every commit to the development branch
- Current stable (v3.0.1): <https://spdx.github.io/spdx-spec/v3.0.1/>
<!-- - Development (v3.1): <https://spdx.github.io/spdx-spec/v3.1-draft/> -->
## Specification development

The specification comprised of documents located in the [`docs/`](./docs/)
directory of this `spdx/spdx-spec` repository,
as well as a model documentation generated from Markdown files within the
[spdx/spdx-3-model](https://github.com/spdx/spdx-3-model/) repository.

Contributions are welcome. Contributions to this repository are made pursuant to the
Contributions, including translations, are welcome.
Contributions to this repository are made pursuant to the
[SPDX Community Specification Contributor License Agreement 1.0](https://github.com/spdx/governance/blob/main/0._SPDX_Contributor_License_Agreement.md).
Please see the contributing guidelines, governance practices,
and build instructions in the
Expand All @@ -49,14 +56,16 @@ This repository consists of these files and directories (partial):
- `front/` - Front matter.
- `images/` - Model diagrams. These image files are to be generated from a
diagram description file
[model.drawio](https://github.com/spdx/spdx-3-model/blob/main/model.drawio)
in `spdx/spdx-3-model` repo and manually copied here.
[model.drawio](https://github.com/spdx/spdx-3-model/blob/develop/docs/model.drawio)
in the `spdx/spdx-3-model` repo and manually copied here.
- `licenses/` - Licenses that used by the SPDX specifications.
- `model/` - Model files. This subdirectory _is to be created_ by a script
from `spdx/spec-parser` repo, using model information from
`spdx/spdx-3-model` repo (see the build instructions below).
`spdx/spdx-3-model` repo (see the [build instructions](./build.md)).
- `examples/` - Examples of various SPDX serializations for the current version
of the spec.
- `rdf/` - Model RDF files. These ontology files are generated from model
Markdown files in the `spdx/spdx-3-model` repo and manually copied here.
- `mkdocs.yml` - MkDocs recipe for the spec documentation generation. The
inclusion of model files and the order of chapters are defined here.

Expand All @@ -67,9 +76,22 @@ The SPDX spec repo follows the [Gitflow](https://gist.github.com/HeratPatel/271b
The branches in use are:

- `main` - This will always be the latest released specification.
- `develop` - This branch will be where the active development for the next major or minor version takes place. Once released, the `develop` branch will be merged into the `main` branch.
- `support/x.y` - These branches will be long lived and contain any updates to a minor version of the specification. Additions such as translations can be added to the support branch. `x.y` represents the major.minor version. Once any changes are accepted and released, the support branch will be tagged and merged into both the develop and main branches.
- General feature or fix branches - there may be feature branches made for specific enhancements or fixes to the spec. These will be short lived and merged into either a support branch or the develop branch.
- `develop` - This branch will be where the active development for the next
major or minor version takes place.
Once released, the `develop` branch will be merged into the `main` branch.
- `support/x.y` - These branches will be long-lived and contain any updates to
a minor version of the specification.
Additions such as translations can be added to the support branch.
`x.y` represents the MAJOR.MINOR version, following Semantic Versioning
(SemVer) conventions.
Once any changes are accepted and released, the support branch will be tagged
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this is different from what @zvr recommended in issue #1169 where the translations will not be merged. We could document "non-translation ..."

and merged into both `develop` and `main` branches.
- General feature or fix branches - there may be feature branches made for
specific enhancements or fixes to the spec.
These will be short-lived and merged into either a `support` branch or the
`develop` branch.
- `gh-pages` - This branch hosts generated HTML websites for all versions of
the specification. It is primarily managed by an automated workflow.

## Related documents and repositories

Expand Down
Loading