This is an automated email from the ASF dual-hosted git repository. smiklosovic pushed a commit to branch trunk in repository https://gitbox.apache.org/repos/asf/cassandra.git
The following commit(s) were added to refs/heads/trunk by this push: new 85f113bce3 Add pull request template and modify README to include Jira and mailing list link 85f113bce3 is described below commit 85f113bce38278653ffca5139cd7871aee7fe786 Author: Claude Warren, Jr <claude.war...@aiven.io> AuthorDate: Fri Aug 19 07:42:25 2022 +0100 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 --- .build/build-rat.xml | 11 ++++++----- .github/pull_request_template.md | 25 +++++++++++++++++++++++++ README.asc | 8 ++++++-- 3 files changed, 37 insertions(+), 7 deletions(-) diff --git a/.build/build-rat.xml b/.build/build-rat.xml index 6a3d72e1ca..522dbd24be 100644 --- a/.build/build-rat.xml +++ b/.build/build-rat.xml @@ -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"> diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..abcd2168a0 --- /dev/null +++ b/.github/pull_request_template.md @@ -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/) + diff --git a/README.asc b/README.asc index cba3a2b424..decb6ba0e3 100644 --- a/README.asc +++ b/README.asc @@ -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-subscr...@cassandra.apache.org + user-subscr...@cassandra.apache.org. + * Subscribe to the Developer mailing list by sending a mail to + dev-subscr...@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. --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org