spdx-spec icon indicating copy to clipboard operation
spdx-spec copied to clipboard

Update CONTRIBUTING and CHANGELOG

Open bact opened this issue 1 year ago • 4 comments

Some of the contents refer to v2.3, so it needs an update.

Contributing guideline:

  • Add info about sign off
  • Update branch names
    • Minor change to development/v3.0.1 branch
    • Major change to development/v3.1 branch (this may be not accurate, need comments)

Change log:

  • Add release dates for 3.0 (2024-04-15) and 2.3 (2022-11-03)
    • Other releases already have the date, except those two

bact avatar Jun 13 '24 12:06 bact

@goneall noted.

Btw, since we only have a change log file in the spdx-spec repo (and not in the spdx-3-model repo), should I also include the link to the release notes of the model as well in this CHANGELOG.md?

From this:

"See the v3.0 GitHub release notes for changes."

To something like this:

"See the v3.0 GitHub release notes for changes in the spec and in the model."

Or does there other recommended way to have in one place informing the reader about changes in v3.0?

bact avatar Jun 15 '24 21:06 bact

@goneall noted.

Btw, since we only have a change log file in the spdx-spec repo (and not in the spdx-3-model repo), should I also include the link to the release notes of the model as well in this CHANGELOG.md?

From this:

"See the v3.0 GitHub release notes for changes."

To something like this:

"See the v3.0 GitHub release notes for changes in the spec and in the model."

Or does there other recommended way to have in one place informing the reader about changes in v3.0?

Very good point - I think we should point to both changelogs for completeness.

goneall avatar Jun 16 '24 01:06 goneall

A link to model release notes added.

bact avatar Jun 16 '24 10:06 bact

A change log for spdx-3-model repo is now available at https://github.com/spdx/spdx-3-model/blob/main/CHANGELOG.md

bact avatar Jun 29 '24 13:06 bact

@bact - sorry to bother you about one more merge conflict resolution. Since @kestewart has now reviewed, I can merge as soon as the conflicts are resolved.

goneall avatar Aug 09 '24 18:08 goneall

@goneall I will check it now. But so far I can't see the conflicts. There're only two files here and I don't think we change these changelog and contributing anywhere else.

Possible that it is due to my force commit few days ago when I forgot to sign-off.

bact avatar Aug 09 '24 19:08 bact

@goneall I will better open new PR and ping you in 2 mins.

bact avatar Aug 09 '24 19:08 bact

@goneall I copy two files to this PR #1031, please use that one instead. sorry for inconvenience. Will close this.

bact avatar Aug 09 '24 19:08 bact