Update CONTRIBUTING for project's new home #1787
Conversation
CONTRIBUTING.md
Outdated
| * The pull request has a title that clearly summarizes the purpose of the patch | ||
| * The motivation behind the patch is clearly defined in the pull request summary | ||
| * Your name and email have been added to the `AUTHORS` file (for copyright purposes) | ||
| * You agree that your contribution is donated to the Apache Software Foundation (appropriate copyright is on all new files) | ||
| * The patch will merge cleanly | ||
| * The test coverage does not fall below the critical threshold (currently 64%) |
There was a problem hiding this comment.
Current coverage seems to be 50.4% of statements 😞
We should probably update the number here and open an issue to display the coverage in pull requests as a comment (perhaps even enforce the coverage rule in a CI check).
CONTRIBUTING.md
Outdated
| * The patch will merge cleanly | ||
| * The test coverage does not fall below the critical threshold (currently 64%) | ||
| * The merge commit passes the regression test suite on Travis | ||
| * `go fmt` has been applied to the submitted code | ||
| * Notable changes (i.e. new features or changed behavior, bugfixes) are appropriately documented in CHANGELOG.md, functional changes also in godoc | ||
| * A correctly formatted commit message, see https://cassandra.apache.org/_/development/how_to_commit.html#tips |
There was a problem hiding this comment.
It seems to me that it would be helpful to expand the guidance on writing commit messages to a separate section.
Specifically, to say that the description of the commit should explain why the change is necessary
Should we encourage contributors to use signed git commits?
There was a problem hiding this comment.
Should we encourage contributors to use signed git commits?
This isn't project precedence, though it can always be recommended (and should be).
Ultimately, it's not my call.
michaelsembwever
force-pushed
the
mck/CASSANDRA-19723-0
branch
from
c151f90 to
8cd947a
Compare
CONTRIBUTING.md
Outdated
| patch by <Authors>; reviewed by <Reviewers> for CASSANDRA-##### | ||
| ``` | ||
|
|
||
| The 'patch by …; reviewed by' line is important. If enforces our review-than-commit procedure, allowing commits from non-git-branch patches, and is parsed to build the project contribulyse statistics found [here](https://nightlies.apache.org/cassandra/devbranch/misc/contribulyze/html/). |
There was a problem hiding this comment.
Fixed. And a small rewording for clarify.
patch by Mick Semb Wever; reviewed by Martin Sucha for CASSANDRA-19723
michaelsembwever
force-pushed
the
mck/CASSANDRA-19723-0
branch
from
8cd947a to
2a72666
Compare
and update new contribution agreements and CLAs signed.
Commit message must be updated before merging.