Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #177

Merged
merged 3 commits into from
Jul 5, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ contributors:

* Documentation. Public functions *must* have docstrings. Documentation
should also be provided as comments to your code. Finally please include
references to to the relavent papers and equations in those papers.
references to to the relevant papers and equations in those papers.
The recomended reference style guide is:

[TOPX] Cool title about topic X \
Expand Down
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Description
-----------

Insert your PR description here. Thanks for contributing to forest Benchmarking! :)

Checklist
---------

- [ ] The above description motivates these changes.
- [ ] There is a unit test that covers these changes.
- [ ] The code respects the API separation discussed in .github/CONTRIBUTING.md.
- [ ] Relevant references and equations are cited using our standard reference style.
- [ ] All new and existing tests pass locally and on Semaphore.
- [ ] Parameters have type hints with [PEP 484 syntax](https://www.python.org/dev/peps/pep-0484/).
- [ ] Functions and classes have useful sphinx-style docstrings.
- [ ] (New Feature) The docs and example noteboos have been updated accordingly.
kylegulshen marked this conversation as resolved.
Show resolved Hide resolved
- [ ] (Bugfix) The associated issue is referenced above using
[auto-close keywords](https://help.github.com/en/articles/closing-issues-using-keywords).
- [ ] The changelog (`docs/source/changes.rst`) has a description of this change.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---


Tell us the versions of your environment (ensure you are running the latest):

- [ ] forest benchmarking version:
- [ ] pyQuil version:
- [ ] qvm version:
- [ ] quilc version:


**Describe the bug**
A clear and concise description of what the bug is.


**Steps to reproduce the behavior**

1. run this
2. get that
3. ...
4. See error


**Possible solutions**