CASSGO-10 Update CONTRIBUTING.md #1835
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| Common ways to engage with the GoCQL community are: | ||
|
|
||
| - CASSGO project on ASF JIRA |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
Hmm I'm not sure what hyperlink I should use for the ML, I think I'll use the archives link (https://lists.apache.org/[email protected])
CONTRIBUTING.md
Outdated
| @@ -23,21 +37,72 @@ The following is a check list of requirements that need to be satisfied in order | |||
| * Notable changes (i.e. new features or changed behavior, bugfixes) are appropriately documented in CHANGELOG.md, functional changes also in godoc | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
Hmm they are... @michaelsembwever do you have any suggestions regarding this? Is it ok if we just keep using CHANGELOG.md but new entries use JIRA issue IDs instead of GH pull request numbers? Otherwise we'd have to keep CHANGELOG.md around if anyone wants to look at the changelog for older releases and use CHANGES.txt for new releases.
There was a problem hiding this comment.
This is up to you to figure out :)
The server provides CHANGES.txt and NEWS.txt. The former is meant to provide outside-in PoV short description to each change (which jira ticket titles and description often fail at), and the latter important must-read info. Drivers don't need to follow this precedent.
There was a problem hiding this comment.
Oh in that case yeah we should probably keep using CHANGELOG.md but I'll see if I can get other opinions on this.
There was a problem hiding this comment.
updated CONTRIBUTING.md so references to CHANGES.txt are replaced with CHANGELOG.md
joao-r-reis
force-pushed
the
update-contributing
branch
3 times, most recently
from
157c6b5 to
af779fb
Compare
CONTRIBUTING.md
Outdated
| Common ways to engage with the GoCQL community are: | ||
|
|
||
| - [CASSGO project on ASF JIRA](https://issues.apache.org/jira/projects/CASSGO/issues/) | ||
| - Apache Cassandra dev mailing list - [[email protected]](mailto:[email protected]) |
There was a problem hiding this comment.
Is it intended that there is dev-subscribe in the mailto: URL?
There was a problem hiding this comment.
Nope, good catch. Fixed
joao-r-reis
force-pushed
the
update-contributing
branch
from
af779fb to
f13a0b5
Compare
The section for the commit message format is too generic, so this commit adds more details and a clear example of how a commit message should be structured. This commit also makes it clear in CONTRIBUTING.md that JIRA should be used instead of GH issues and encourages contributors to seek feedback and discussion on the proposed changes early. patch by João Reis; reviewed by Mick Semb Wever and Martin Sucha for CASSGO-10
joao-r-reis
force-pushed
the
update-contributing
branch
from
f13a0b5 to
df63d1a
Compare
The section for the commit message format is too generic, so this commit adds more details and a clear example of how a commit message should be structured.
This commit also makes it clear in CONTRIBUTING.md that JIRA should be used instead of GH issues and encourages contributors to seek feedback and discussion on the proposed changes early.