Skip to content

Commit

Permalink
add contributing guidelines
Browse files Browse the repository at this point in the history
Signed-off-by: Jose Borreguero <[email protected]>
  • Loading branch information
jmborr committed Apr 26, 2024
1 parent 4dc9983 commit 6c30591
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ Backend code for the reduction of USANS data.

# User

User guide at [readthedocs]()https://usansred.readthedocs.io/en/latest/source/user.html
User guide at [readthedocs](https://usansred.readthedocs.io/en/latest/source/user.html)

# Developer

Developer documentation at [readthedocs]()https://usansred.readthedocs.io/en/latest/source/developer.html
Developer documentation at [readthedocs](https://usansred.readthedocs.io/en/latest/source/developer.html)

- [contributing to the project](https://usansred.readthedocs.io/en/latest/source/contributing.html)
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Developer Guide
.. toctree::
:titlesonly:

/source/developer/contributing
/source/developer/developer

Contents
Expand Down
43 changes: 43 additions & 0 deletions docs/source/developer/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.. contributing
Guide to Contributing
=====================

Contributions to this project are welcome. All contributors agree to the following:

- It is assumed that the contributor is an ORNL employee and belongs to the development team.
Thus the following instructions are specific to ORNL development team's process.
- You have permission and any required rights to submit your contribution.
- Your contribution is provided under the license of this project and may be redistributed as such.
- All contributions to this project are public.

All contributions must be "signed off" in the commit log and by doing so you agree to the above.

Getting access to the main project
----------------------------------
Direct commit access to the project is currently restricted to core developers.
All other contributions should be done through pull requests.


Development procedure
---------------------

1. A developer is assigned with a task during neutron status meeting and changes the task's status to **In Progress**.
2. The developer creates a branch off *next* and completes the task in this branch.
3. The developer creates a pull request (PR) off *next*.
4. The developer asks for another developer as a reviewer to review the PR.
A PR can only be approved and merged by the reviewer.
5. The developer changes the task’s status to **Complete** and closes the associated issue.


Contacting the Team
-------------------
The best mechanism for a user to request a change is to contact the SANS CIS.
Please email `Yingrui Shang`_ with your request.

.. _Yingrui Shang: [email protected]

A change needs to be in the form of a:

- Story for any enhancement request
- Defect for any bug fix request.

0 comments on commit 6c30591

Please sign in to comment.