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

Add guidelines for lightning.qubit repository #109

Merged
merged 6 commits into from
Jul 13, 2021
Merged

Add guidelines for lightning.qubit repository #109

merged 6 commits into from
Jul 13, 2021

Conversation

mlxd
Copy link
Member

@mlxd mlxd commented Jul 9, 2021

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 and PULL_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:

@codecov
Copy link

codecov bot commented Jul 9, 2021

Codecov Report

Merging #109 (d00ba53) into master (ec87485) will not change coverage.
The diff coverage is n/a.

❗ Current head d00ba53 differs from pull request most recent head 353b0db. Consider uploading reports for the commit 353b0db to get more accurate results
Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ec87485...353b0db. Read the comment docs.

@mlxd mlxd requested review from antalszava and trbromley July 9, 2021 10:20
Copy link
Contributor

@trbromley trbromley left a 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!


- [ ] 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!
Copy link
Contributor

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

Copy link
Member Author

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.

Copy link
Member Author

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.

.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
@mlxd mlxd merged commit f7bf3be into master Jul 13, 2021
@mlxd mlxd deleted the repo_guidelines branch July 13, 2021 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants