-
Notifications
You must be signed in to change notification settings - Fork 39
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
Add guidelines for lightning.qubit repository #109
Conversation
Codecov Report
@@ Coverage Diff @@
## master #109 +/- ##
=======================================
Coverage 98.14% 98.14%
=======================================
Files 3 3
Lines 54 54
=======================================
Hits 53 53
Misses 1 1 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @mlxd, looks great!
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
||
- [ ] All new features must include a unit test. | ||
If you've fixed a bug or added code that should be tested, add a test to the | ||
[`tests/`](tests/) directory! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, I didn't know you could do links like this! But it doesn't work, does it need a ../tests/
? This is the URL it sends to:
https://github.com/PennyLaneAI/pennylane-lightning/blob/repo_guidelines/.github/tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! I forgot to add a sufficient number of ../
. I'll update this to be absolute to the tests
dir, rather than relative.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On second thought, the relative path you suggested is much tidier.
Context: Currently there are no repository guidelines for creating issues, PRs, or general contribution information. This PR will add support for this.
Description of the Change: Added
CODE_OF_CONDUCT.md
,CONTRIBUTING.md
ISSUE_TEMPLATE.md
andPULL_REQUEST_TEMPLATE.md
modeled on main PennyLane repository.Benefits: Enables users to contribute more easily, and adds guidelines for creating PRs.
Possible Drawbacks: None
Related GitHub Issues: