Permalink
Browse files

added pull request template and docs issue template (#71)

* added pull request template and docs issue template

Closes #47
Closes #52

* addressed CR comments
  • Loading branch information...
leifwalsh committed Jun 14, 2018
1 parent 80cee93 commit 932993bc93556f2e7a5f616e5a0b04e19ee0ca5b
Showing with 38 additions and 0 deletions.
  1. +14 −0 .github/ISSUE_TEMPLATE/docs_suggestion.md
  2. +24 −0 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,14 @@
---
name: Docs suggestion
about: Request an improvement to the docs

---

### Description
Describe what you would like to see better documented.

### Intended audience
Who is the audience for the documentation improvement? Developers, users, maintainers?

### Additional context
Add any other context about the suggestion here.
@@ -0,0 +1,24 @@
## Purpose
_Describe the problem or feature in addition to a link to the issues._

## Approach
_How does this change address the problem?_

## Tests for New Behavior
_What new tests were added to cover new features or behaviors?_

## Checklist
_Make sure you did the following (if applicable):_
- [ ] Signed and returned a copy of the [CLA](https://github.com/twosigma/marbles/tree/master/cla)
- [ ] Added tests for any new features or behaviors
- [ ] Ran ``tox -e flake8`` to make sure code style is consistent
- [ ] Built and reviewed the docs
- [ ] Added a note to the [changelog](https://github.com/twosigma/marbles/blob/master/docs/changelog.rst)

#### Open Questions and Pre-Merge TODOs
- [ ] Use GitHub checklists. When solved, check the box and explain the answer.

## Learning
_Describe the research stage_

_Links to blog posts, patterns, libraries or addons used to solve this problem_

0 comments on commit 932993b

Please sign in to comment.