Skip to content

Commit

Permalink
Merge pull request #685 from basho/issue-pr-templates
Browse files Browse the repository at this point in the history
Update GitHub PR and Issue templates
  • Loading branch information
alexmoore authored Nov 9, 2016
2 parents b81de22 + 1b4a2e3 commit 709ce84
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 7 deletions.
7 changes: 4 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,22 @@ 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).

### Pull Request Process

Here’s how to get started:

* Fork the appropriate sub-projects that are affected by your change.
* [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`
* Make your changes and run the test suite.
* 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.
26 changes: 25 additions & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
Please ensure the following information is supplied for new issues:
<!--- Provide a general summary of the issue in the Title above -->

## Context
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->

## Expected Behavior
<!--- Tell us what should happen -->

## Actual Behavior
<!--- Tell us what happens instead -->

## Possible Fix
<!--- Not obligatory, but suggest a fix or reason for the bug -->

## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug include code to reproduce, if relevant -->
1.
2.
3.
4.

## Context
<!--- How has this bug affected you? What were you trying to accomplish? -->

## Your Environment
- [ ] Riak Java Client version
- [ ] Java version
- [ ] Riak version
Expand Down
34 changes: 31 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,34 @@
Please ensure the following is present in your PR:
<!--- Provide a general summary of your changes in the Title above -->

- [ ] Unit tests for your change
- [ ] Integration tests (if applicable)
## Description
<!--- Describe your changes in detail -->

## Related Issue
<!--- This project only accepts pull requests related to open github issues or internal JIRA tickets -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue/ticket here: -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] 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.

0 comments on commit 709ce84

Please sign in to comment.