Skip to content

Commit d9ca5ce

Browse files
committed
Add Issue and PR templates
1 parent 3a02a4d commit d9ca5ce

2 files changed

Lines changed: 50 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## This issue is a (choose one):
2+
3+
- [ ] Problem/bug report.
4+
- [ ] Feature request.
5+
- [ ] Request for support. **Note: Please try to avoid submitting issues for support requests. Use [Gitter](https://gitter.im/cerebris/jsonapi-resources) instead.**
6+
7+
## Checklist before submitting:
8+
9+
- [ ] I've searched for an existing issue.
10+
- [ ] I've asked my question on [Gitter](https://gitter.im/cerebris/jsonapi-resources) and have not received a satisfactory answer.
11+
- [ ] I've included a complete [bug report template](https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb). This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
12+
- [ ] The feature I'm asking for is compliant with the [JSON:API](http://jsonapi.org/) spec.
13+
14+
## Description
15+
16+
Choose one section below and delete the other:
17+
18+
### Bug reports:
19+
20+
Please review [Did you find a bug?](https://github.com/cerebris/jsonapi-resources/blob/master/README.md#did-you-find-a-bug) and replace this content with a brief summary of your issue. If you can't submit a [bug report template](https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb) please be as thorough as possible when describing your your description. It's helpful to indicate which version of ruby and the JR gem you are using.
21+
22+
### Features:
23+
24+
Please replace this line with a clear writeup of your feature request. Features that break compliance with the [JSON:API](http://jsonapi.org/) spec will probably be closed.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
3+
### All Submissions:
4+
5+
- [ ] I've checked to ensure there aren't other open [Pull Requests](https://github.com/cerebris/jsonapi-resources/pulls) for the same update/change.
6+
- [ ] I've submitted a [ticket](https://github.com/cerebris/jsonapi-resources/issues) for my issue if one did not already exist.
7+
- [ ] My submission passes all tests. (Please run the full test suite locally to cut down on noise from travis failures.)
8+
- [ ] I've used Github [auto-closing keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) in the commit message or the description.
9+
- [ ] I've added/updated tests for this change.
10+
11+
### New Feature Submissions:
12+
13+
- [ ] I've submitted an issue that describes this feature, and received the go ahead from the maintainers.
14+
- [ ] My submission includes new tests.
15+
- [ ] My submission maintains compliance with [JSON:API](http://jsonapi.org/).
16+
17+
### Bug fixes and Changes to Core Features:
18+
19+
- [ ] I've included an explanation of what the changes do and why I'd like you to include them.
20+
- [ ] I've provided test(s) that fails without the change.
21+
22+
### Test Plan:
23+
24+
### Reviewer Checklist:
25+
- [ ] Maintains compliance with JSON:API
26+
- [ ] Adequate test coverage exists to prevent regressions

0 commit comments

Comments
 (0)