Skip to content

Commit

Permalink
update contrib
Browse files Browse the repository at this point in the history
  • Loading branch information
jackaraz committed Jun 14, 2024
1 parent 9794c85 commit 38d70f1
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,35 +1,33 @@
Contributing to Spey
====================

We are happy to accept contributions to ``spey`` via
We welcome contributions to ``spey`` via
`Pull Requests to our GitHub repository <https://github.com/SpeysideHEP/spey/pulls>`_.
You can begin this by forking the ``main`` repository.
To get started, fork the ``main`` repository.

Unless there is a minimal fix that does not require any discussion, please
always first `open an issue <https://github.com/SpeysideHEP/spey/issues/new/choose>`_
For anything beyond minimal fixes that do not require discussion, please first `open an issue <https://github.com/SpeysideHEP/spey/issues/new/choose>`_
to discuss your request with the development team.

If the desired change is not limited to a couple of lines of code, please create
a draft pull request. This draft should detail the context of the change, its
description and the benefits of the implementation.
If your proposed changes are more extensive than a few lines of code, please create a draft pull request.
This draft should include the context of the change, a description, and the benefits of the implementation.

* If there is a change within the Python interface of the program, please proceed with standard tests and write extra tests if necessary.
* Please also make sure to add examples of using the new implementation.
* If your implementation has any drawbacks, these should be specified. Possible solutions should be offered, if any.
* For changes within the Python interface of the program, please run standard tests and write additional tests if necessary.
* Ensure you add examples demonstrating the new implementation.
* Specify any drawbacks of your implementation and offer possible solutions if available.


Pull request procedure
----------------------

Here are the steps to follow to make a pull request:
Follow these steps to submit a pull request:

1. Fork the ``spey`` repository.
2. Open an issue and discuss the implementation with the developers.
3. Commit your changes to a feature branch on your fork and push all your changes there.
3. Commit your changes to a feature branch on your fork and push all your changes.
4. Start a draft pull request and inform the developers about your progress.
5. Pull the main branch to ensure there is no conflict with the current code developments.
6. Make sure you modified the appropriate section of ``docs/releases/changelog-dev.md``.
7. Once you are done, request one of the maintainers to review your PR.
5. Pull the ``main`` branch to ensure there are no conflicts with the current code developments.
6. Modify the appropriate section of ``docs/releases/changelog-dev.md``.
7. Once complete, request a review from one of the maintainers.

Docstring style
~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 38d70f1

Please sign in to comment.