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

Update CONTRIBUTING and CHANGELOG #973

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
ce06a94
Update CONTRIBUTING and CHANGELOG
bact Jun 13, 2024
27b7f5b
Add release notes for the model
bact Jun 16, 2024
66518b3
Adds a new annex on license matching
zvr Jun 1, 2024
21ab84e
Adds pkg-url spec as an annex
zvr Jun 1, 2024
53390de
Update publish_v3.yml to alias "v3.0" as "latest"
bact Apr 28, 2024
fd46502
Set mike canonical_version
bact Apr 28, 2024
bac7569
Update CI to build from and generate 3.0.1
bact May 6, 2024
ab559d9
Update .github/workflows/publish_v3.yml
bact Jul 16, 2024
d3a5134
Use 3.0.1 for now
bact Jul 16, 2024
23beb27
Fix Philippe Ombredanne name
vargenau Apr 26, 2024
4e9db4b
[3.0] Use H2 for headings in Annex A to fix nav bar issue
bact Jul 10, 2024
19cbbbb
Put together text portions from the same bullet
bact Jul 10, 2024
9a1e1dd
Fix cardinality to conform to the full SPDX specification due to type…
NorioKobota Jul 9, 2024
690a79a
specVersion should be Semver.
NorioKobota Jul 9, 2024
11d78df
Revise comments to make it a little clearer.
NorioKobota Jul 9, 2024
dbd74b7
Add clarification for case-sensitivity for LicenseRef-
vargenau Jul 9, 2024
04bdc49
Update docs/annexes/SPDX-license-expressions.md
vargenau Jul 16, 2024
31a90d0
Set 3.0.1 as draft at this dev moment
bact Jul 18, 2024
15f2173
Add comment on stable release
bact Jul 18, 2024
c4aa2f1
Add comment for canonical_version
bact Jul 18, 2024
644fcb2
Reorder arguments
bact Jul 18, 2024
af910c0
Mark the v3.0.1 DRAFT at copyright line
bact Jul 18, 2024
047e971
Add site description
bact Jul 18, 2024
0c28318
Add comment on 3.0.1 checkout
bact Jul 18, 2024
47afe78
Add DRAFT mark
bact Jul 18, 2024
7da7a6b
Fix yaml indent
bact Jul 18, 2024
113b2b7
Update mkdocs.yml
bact Jul 24, 2024
e7050e3
checkout commit instead of checkout tag
bact Jul 25, 2024
283148b
Upgrade to mkdocs 1.6 to fix nav issue
bact Jul 25, 2024
d7142e3
Use mkdocs-files.yml for model list
bact Jul 25, 2024
af7ab89
Update PR validation to use mkdocs-files.yml
bact Jul 25, 2024
484c294
Make redirection work for default Ubuntu shell
bact Jul 25, 2024
2a9170f
Remove trailing space in sed -e expression
bact Jul 25, 2024
23b150a
Use one-line sed
bact Jul 25, 2024
f4e5bf0
Use | for sed delimiter instead of /
bact Jul 25, 2024
5f1118f
Use | delimiter in sed
bact Jul 25, 2024
aa8c322
Use one-line sed with | delimiter
bact Jul 25, 2024
b7bd370
Remove unnecessary temp file
bact Jul 25, 2024
5a81b82
Make sed multiple lines
bact Jul 25, 2024
13efc9e
Insert new line after mkdocs-files.yml
bact Jul 25, 2024
39325e2
Add blank line between insert and delete expression in sed
bact Jul 25, 2024
a60d492
Add mkdocs validation and draft_docs
bact Jul 25, 2024
478d989
Use enabled_if_env to switch pdf-export
bact Jul 26, 2024
ff127ca
Add 3.0 release announcement link on Linux Foundation website
bact Aug 1, 2024
e8d2a78
Add link to spdx/meetings
bact Aug 1, 2024
b9e4a50
Merge branch 'spdx:development/v3.0.1' into update-contributing-guide…
bact Aug 1, 2024
6e1cfd5
Merge branch 'spdx:development/v3.0.1' into update-contributing-guide…
bact Aug 8, 2024
151553a
Merge branch 'development/v3.0.1' into update-contributing-guideline
kestewart Aug 9, 2024
fd025e5
Merge branch 'development/v3.0.1' into update-contributing-guideline
kestewart Aug 9, 2024
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
11 changes: 8 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# Change Log

All notable changes to this project will be documented in this file.

## 3.0
## 3.0 (2024-04-15)

See the v3.0 GitHub release notes for changes
[in the spec](https://github.com/spdx/spdx-spec/releases/tag/v3.0) and
[in the model](https://github.com/spdx/spdx-3-model/releases/tag/3.0).

See the [v3.0 GitHub release notes](https://github.com/spdx/spdx-spec/releases/tag/v3.0) for changes.
See also the [SPDX specification 3.0 release announcement](https://www.linuxfoundation.org/press/spdx-3-revolutionizes-software-management-in-systems-with-enhanced-functionality-and-streamlined-use-cases)

## 2.3
## 2.3 (2022-11-03)

See the [v2.3 GitHub release notes](https://github.com/spdx/spdx-spec/releases/tag/v2.3) for changes.

Expand Down
77 changes: 58 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,83 @@
# Contributing

The SPDX specification is maintained by the SPDX [legal][spdx-legal] and [tech][spdx-tech] teams.
Design and planning is primarily done via the team [mailing][spdx-legal-list] [lists][spdx-tech-list] and meetings.
The SPDX specification is maintained by the SPDX [legal][spdx-legal] and
[tech][spdx-tech] teams.
Design and planning is primarily done via the team [mailing][spdx-legal-list]
[lists][spdx-tech-list] and [meetings][meetings].

## Contribution License Agreement

Contributions to this repo are made pursuant to the [SPDX Community Specification Contributor License Agreement 1.0][cla]. You do not need to submit a signed copy of the contributor license agreement; by making a contribution to this repo, you agree to the terms set forth in that agreement.
Contributions to this repo are made pursuant to the
[SPDX Community Specification Contributor License Agreement 1.0][cla]. You do
not need to submit a signed copy of the contributor license agreement; by
making a contribution to this repo, you agree to the terms set forth in that
agreement.

## Submitting changes

Always write a clear log message for your commits. One-line messages are fine for small changes, but significant changes should look like this:
Always write a clear log message for your commits. One-line messages are fine
for small changes, but significant changes should look like this:

$ git commit -m "Subject of the commit
>
> A paragraph describing what changed and its impact."
```shell
$ git commit -m "Subject of the commit
>
> A paragraph describing what changed and its impact.
>
> Signed-off-by: Contributor Name <name@example.com>"
```

A properly formed Git commit subject line should always be able to complete the following sentence: if applied, this commit will "Subject of the commit". For example :
Every commit message also needs a sign-off line, or it will not pass a test in
the workflow. This line starts with `Signed-off-by:` and specifies the name and
the email address of the person who submitted the changes. You can also use the
`-s` or `--signoff` option with `git commit` to automatically append the line
to your commit message (it will use `user.name` and `user.email` from your
`.git/config` configuration file).

if applied, this commit will Add chapter on Security Vunerabilities in SPDX
if applied, this commit will Delete section with deprecated SPDX attributes
if applied, this commit will Fix grammar in Package Version field description
A properly formed Git commit subject line should always be able to complete the
following sentence: if applied, this commit will "Subject of the commit".

Git itself uses this approach. When you merge something it will generate a commit message like "Merge branch...", or when reverting "Revert...".
For example :

```text
if applied, this commit will Add chapter on Security Vunerabilities in SPDX
if applied, this commit will Delete section with deprecated SPDX attributes
if applied, this commit will Fix grammar in Package Version field description
```

Git itself uses this approach. When you merge something it will generate a
commit message like "Merge branch...", or when reverting "Revert...".

### Minor Changes
Minor changes such as markup and typo fixes may be submitted directly to this repository (either as [issues][] or [pull-requests][]) without previous discussion.
Please submit all minor changes against the `development/v2.3` branch which is the current version of the SPDX specification.

Minor changes such as markup and typo fixes may be submitted directly to this
repository (either as [issues][] or [pull-requests][]) without previous
discussion.

Please submit all minor changes against the `development/v3.0.1` branch which
is the current development version of the SPDX specification.

### Major Changes
Any change that break backwards compatibility or requires significant tooling changes is considered a major change.
You may want to discuss major changes on the mailing list first to get design feedback before investing time in a pull request.
Please submit all major changes against the `development/v3.0` which is the next major version of the specification.

Any change that break backwards compatibility or requires significant tooling
changes is considered a major change.
You may want to discuss major changes on the mailing list first to get design
feedback before investing time in a pull request.

Please submit all major changes against the `development/v3.1` which is the
next major version of the specification.

### Target Milestones
When submitting an issue or pull request, please add a suggested release milestone. This will ensure the issue or pull request is reviewed for inclusion in that release.

If your issue or pull request is independent of a release, you can use the `release-independent` milestone.
When submitting an issue or pull request, please add a suggested release
milestone. This will ensure the issue or pull request is reviewed for inclusion
in that release.

If your issue or pull request is independent of a release, you can use the
`release-independent` milestone.

[cla]: https://github.com/spdx/governance/blob/main/0._SPDX_Contributor_License_Agreement.md
[issues]: https://github.com/spdx/spdx-spec/issues/
[meetings]: https://github.com/spdx/meetings/
[pull-requests]: https://github.com/spdx/spdx-spec/pulls/
[spdx-legal]: https://wiki.spdx.org/view/Legal_Team
[spdx-legal-list]: https://lists.spdx.org/mailman/listinfo/spdx-legal
Expand Down
Loading