Add pull request template and modify README to include Jira and mailing list link

patch by claudenw; reviewed by dritfx, dcapwell, josh-mckenzie, michaelsembwever and smiklosovic for CASSANDRA-17837
This commit is contained in:
Claude Warren, Jr 2022-08-19 07:42:25 +01:00 committed by Stefan Miklosovic
parent 73c0f7f2af
commit 85f113bce3
3 changed files with 37 additions and 7 deletions

View File

@ -49,13 +49,14 @@
<fileset dir="." includesfile="build/.ratinclude">
<!-- Config files with not much creativity -->
<exclude name="**/.asf.yaml"/>
<exclude name="**/.github/pull_request_template.md"/>
<exclude name="**/ide/**/*"/>
<exclude name="**/metrics-reporter-config-sample.yaml"/>
<exclude name="**/cassandra.yaml"/>
<exclude name="**/cassandra-murmur.yaml"/>
<exclude name="**/cassandra-seeds.yaml"/>
<exclude name="**/harry-generic.yaml"/>
<exclude NAME="**/doc/antora.yml"/>
<exclude name="**/doc/antora.yml"/>
<exclude name="**/test/conf/cassandra.yaml"/>
<exclude name="**/test/conf/cassandra-old.yaml"/>
<exclude name="**/test/conf/cassandra-converters-special-cases-old-names.yaml"/>
@ -80,12 +81,12 @@
<exclude name="**/tools/cqlstress-insanity-example.yaml"/>
<exclude name="**/tools/cqlstress-lwt-example.yaml"/>
<!-- Documentation files -->
<exclude NAME="**/doc/modules/**/*"/>
<exclude NAME="**/src/java/**/*.md"/>
<exclude name="**/doc/modules/**/*"/>
<exclude name="**/src/java/**/*.md"/>
<!-- NOTICE files -->
<exclude NAME="**/NOTICE.md"/>
<exclude name="**/NOTICE.md"/>
<!-- LICENSE files -->
<exclude NAME="**/LICENSE.md"/>
<exclude name="**/LICENSE.md"/>
</fileset>
</rat:report>
<exec executable="grep" outputproperty="rat.failed.files" failifexecutionfails="false">

25
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,25 @@
Thanks for sending a pull request! Here are some tips if you're new here:
* Ensure you have added or run the [appropriate tests](https://cassandra.apache.org/_/development/testing.html) for your PR.
* Be sure to keep the PR description updated to reflect all changes.
* Write your PR title to summarize what this PR proposes.
* If possible, provide a concise example to reproduce the issue for a faster review.
* Read our [contributor guidelines](https://cassandra.apache.org/_/development/index.html)
* If you're making a documentation change, see our [guide to documentation contribution](https://cassandra.apache.org/_/development/documentation.html)
Commit messages should follow the following format:
```
<One sentence description, usually Jira title or CHANGES.txt summary>
<Optional lengthier description (context on patch)>
patch by <Authors>; reviewed by <Reviewers> for CASSANDRA-#####
Co-authored-by: Name1 <email1>
Co-authored-by: Name2 <email2>
```
The [Cassandra Jira](https://issues.apache.org/jira/projects/CASSANDRA/issues/)

View File

@ -9,6 +9,8 @@ https://cwiki.apache.org/confluence/display/CASSANDRA2/DataModel[Row store] mean
For more information, see http://cassandra.apache.org/[the Apache Cassandra web site].
Issues should be reported on https://issues.apache.org/jira/projects/CASSANDRA/issues/[The Cassandra Jira].
Requirements
------------
. Java >= 1.8 (OpenJDK and Oracle JVMS have been tested)
@ -76,8 +78,10 @@ reasonable way to think of it is as, "SQL minus joins and subqueries, plus colle
Wondering where to go from here?
* Join us in #cassandra on the https://s.apache.org/slack-invite[ASF Slack] and ask questions
* Join us in #cassandra on the https://s.apache.org/slack-invite[ASF Slack] and ask questions.
* Subscribe to the Users mailing list by sending a mail to
user-subscribe@cassandra.apache.org
user-subscribe@cassandra.apache.org.
* Subscribe to the Developer mailing list by sending a mail to
dev-subscribe@cassandra.apache.org.
* Visit the http://cassandra.apache.org/community/[community section] of the Cassandra website for more information on getting involved.
* Visit the http://cassandra.apache.org/doc/latest/development/index.html[development section] of the Cassandra website for more information on how to contribute.