CONTRIBUTING.rst 1.65 KB
Newer Older
Peterson, Peter's avatar
Peterson, Peter committed
1
2
Guide to Contributing
=====================
Doucet, Mathieu's avatar
Doucet, Mathieu committed
3
4

Contributions to this project are welcome. All contributors agree to the following:
5
- 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.
Doucet, Mathieu's avatar
Doucet, Mathieu committed
6
7
8
9
10
11
- 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.

Peterson, Peter's avatar
Peterson, Peter committed
12
13
14
15
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.
Doucet, Mathieu's avatar
Doucet, Mathieu committed
16

17
18
19
20
21
22
23
24
25
26
27

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 merge request (MR) off *next*.
4. The developer asks for another developer as a reviewer to review the MR.  An MR can only be approved and merged by the reviewer.
5. The developer changes the task’s status to **Complete** and closes the associated issue.


Peterson, Peter's avatar
Peterson, Peter committed
28
29
Contacting the Team
-------------------
30
31
32
33
34
35
36
37
38
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: shangy@ornl.gov

A change needs to be in the form of a:

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