From c27bb58b562330ef4c6f3e727d153fa105dfe4c4 Mon Sep 17 00:00:00 2001 From: Alex Moore Date: Wed, 9 Nov 2016 13:33:27 -0500 Subject: [PATCH 1/3] Update PR and issue templates --- .github/CONTRIBUTING.md | 2 +- .github/ISSUE_TEMPLATE.md | 24 +++++++++++++++++++++++- .github/PULL_REQUEST_TEMPLATE.md | 31 ++++++++++++++++++++++++++++--- 3 files changed, 52 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8302e0324..13f3a6b0a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -14,7 +14,7 @@ This repo's maintainers are engineers at Basho and welcome your contribution to Here’s how to get started: -* Fork the appropriate sub-projects that are affected by your change. +* Fork the appropriate sub-projects that are affected by your change. * Create a topic branch for your change and checkout that branch. `git checkout -b some-topic-branch` * Make your changes and run the test suite. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c76e1a289..aec0674cc 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,5 +1,27 @@ -Please ensure the following information is supplied for new issues: +## Context + +## Expected Behavior + + +## Actual Behavior + + +## Possible Fix + + +## Steps to Reproduce + + +1. +2. +3. +4. + +## Context + + +## Your Environment - [ ] Riak Java Client version - [ ] Java version - [ ] Riak version diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c697e45e6..57b3b0f00 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,31 @@ -Please ensure the following is present in your PR: +## Description + -- [ ] Unit tests for your change -- [ ] Integration tests (if applicable) +## Related Issue + + + + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: +- [ ] My code follows the code style of this project. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. +- [ ] Javadoc comments for any new public classes, interfaces, etc. +- [ ] A basho_docs PR for new or changed features (basho/basho_docs#???) Pull requests that are small and limited in scope are most welcome. From 5f8a390c239f64dfec6c8d64a97a289be1d26e77 Mon Sep 17 00:00:00 2001 From: Alex Moore Date: Wed, 9 Nov 2016 13:53:41 -0500 Subject: [PATCH 2/3] Ask for Issue before PR, add link to help testing --- .github/CONTRIBUTING.md | 3 ++- .github/ISSUE_TEMPLATE.md | 2 ++ .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++---- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 13f3a6b0a..bf04edd21 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -9,11 +9,13 @@ This repo's maintainers are engineers at Basho and welcome your contribution to * Whether your contribution is for a bug fix or a feature request, **create an [Issue](https://github.com/basho/riak-java-client/issues)** and let us know what you are thinking. * **For bugs**, if you have already found a fix, feel free to submit a Pull Request referencing the Issue you created. * **For feature requests**, we want to improve upon the library incrementally which means small changes at a time. In order ensure your PR can be reviewed in a timely manner, please keep PRs small, e.g. <10 files and <500 lines changed. If you think this is unrealistic, then mention that within the Issue and we can discuss it. +* For help on running Integration tests, please see [The README section on this subject](https://github.com/basho/riak-java-client#contributing). ### Pull Request Process Here’s how to get started: +* [Create an Issue](https://github.com/basho/riak-java-client/issues/new) that explains the bug or new feature. * Fork the appropriate sub-projects that are affected by your change. * Create a topic branch for your change and checkout that branch. `git checkout -b some-topic-branch` @@ -21,6 +23,5 @@ Here’s how to get started: * Commit your changes and push them to your fork. * Open pull-requests for the appropriate projects. * Contributors will review your pull request, suggest changes, and merge it when it’s ready and/or offer feedback. -* To report a bug or issue, please open a new issue against this repository. You can [read the full guidelines for bug reporting and code contributions](http://docs.basho.com/riak/latest/community/bugs/) on the Riak Docs. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index aec0674cc..2ed6968d2 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,3 +1,5 @@ + + ## Context diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 57b3b0f00..5bf64fd73 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,22 @@ + + ## Description ## Related Issue - + - + + +## Motivation and Context + ## How Has This Been Tested? -## Screenshots (if appropriate): - ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) From 1b4a2e36a5cce14afcc128c9cd8a9da463f67031 Mon Sep 17 00:00:00 2001 From: Alex Moore Date: Wed, 9 Nov 2016 14:00:03 -0500 Subject: [PATCH 3/3] Small Review Edits. --- .github/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bf04edd21..0b5f9d839 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,16 +6,16 @@ This repo's maintainers are engineers at Basho and welcome your contribution to **_IMPORTANT_**: This is an open source project licensed under the Apache 2.0 License. We encourage contributions to the project from the community. We ask that you keep in mind these considerations when planning your contribution. -* Whether your contribution is for a bug fix or a feature request, **create an [Issue](https://github.com/basho/riak-java-client/issues)** and let us know what you are thinking. +* Whether your contribution is for a bug fix or a feature request, **create an [issue](https://github.com/basho/riak-java-client/issues)** and let us know what you are thinking. * **For bugs**, if you have already found a fix, feel free to submit a Pull Request referencing the Issue you created. * **For feature requests**, we want to improve upon the library incrementally which means small changes at a time. In order ensure your PR can be reviewed in a timely manner, please keep PRs small, e.g. <10 files and <500 lines changed. If you think this is unrealistic, then mention that within the Issue and we can discuss it. -* For help on running Integration tests, please see [The README section on this subject](https://github.com/basho/riak-java-client#contributing). +* For help on running Integration tests, please see [the README section on this subject](https://github.com/basho/riak-java-client#contributing). ### Pull Request Process Here’s how to get started: -* [Create an Issue](https://github.com/basho/riak-java-client/issues/new) that explains the bug or new feature. +* [Create an issue](https://github.com/basho/riak-java-client/issues/new) that explains the bug or new feature. * Fork the appropriate sub-projects that are affected by your change. * Create a topic branch for your change and checkout that branch. `git checkout -b some-topic-branch`