Skip to content

Commit

Permalink
small changes to contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
josh146 committed Apr 19, 2018
1 parent edebf99 commit 92633c7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
13 changes: 13 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,19 @@ Before submitting a pull request, please make sure the following is done:
* When describing the pull request, please include as much detail as possible regarding the changes made/new features
added/performance improvements. If including any bug fixes, mention the issue numbers associated with the bugs.

* Once you have submitted the pull request, three things will automatically occur:

- The **test suite** will automatically run on [Travis CI](https://travis-ci.org/XanaduAI/strawberryfields)
to ensure that the all tests continue to pass.
- Once the test suite is finished, a **code coverage report** will be generated on
[Codecov](https://codecov.io/gh/XanaduAI/strawberryfields). This will calculate the percentage of Strawberry Fields
covered by the test suite, to ensure that all new code additions are adequately tested.
- Finally, the **code quality** is calculated by [Codacy](https://app.codacy.com/app/XanaduAI/strawberryfields/dashboard),
to ensure all new code additions adhere to our code quality standards.

Based on these reports, we may ask you to make small changes to your branch before merging the pull request into the master branch. Alternatively, you can also
[grant us permission to make changes to your pull request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/).

:strawberry: Thank you for joining the Strawberry Fields contribution effort! :strawberry:

\- The Strawberry Fields team
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ Contributing to Strawberry Fields
We welcome contributions - simply fork the Strawberry Fields repository, and then make a
`pull request <https://help.github.com/articles/about-pull-requests/>`_ containing your contribution.

For more details on contributing to Strawberry Fields, see
`Contributing to Strawberry Fields <https://github.com/XanaduAI/strawberryfields/blob/master/.github/CONTRIBUTING.md>`_.
See `Contributing to Strawberry Fields <https://github.com/XanaduAI/strawberryfields/blob/master/.github/CONTRIBUTING.md>`_
for more details on contributing to Strawberry Fields.


Support
Expand Down

0 comments on commit 92633c7

Please sign in to comment.