Skip to content

Commit 804f8a9

Browse files
authored
Update CONTRIBUTING.md
1 parent a141ad2 commit 804f8a9

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,22 @@
22

33
Thanks for your interest in the project!
44

5-
Any contribution, project participation and pull request from developers of all skill levels is welcome. Please follow this process:
5+
Any contribution, project participation and pull request from developers are welcome. Please follow this process:
66
1. create a new branch (out of the current master branch and with a descriptive name)
77
2. implement your changes
88
3. start a pull-request (merge into master branch)
99

10+
1. Clone this repository or fork it. Create a new branch and add your modifications.
11+
2. Remember to add unit tests to verify the desired behavior of the new features or methods.
12+
3. When the first version of the code is ready, create a pull-request to the **development** branch of `iqusoft/intel-qs`.
13+
4. Edits may be required to resolve conflicts since it is possible that the repository has changed while you worked on your new contribution.
14+
Please resolve the merge conflicts.
15+
5. Verify that all unit tests, and not only the one added in the contribution, run correctly.
16+
6. The IQS team will help with the revision of the pull-request.
17+
18+
To facilitate the review consider starting with small contributions (a couple files and ~100 lines).
19+
For contributions that require substantial changes or changes in many files, please contact the IQS team to discuss the most effective strategy.
20+
1021
Creating your pull request from a fork? We suggest allowing edits from maintainers. Then, anyone with Write access to the upstream repository will be able to add commits to your branch. This can make the review process easier for maintainers since they can make a small change themselves instead of asking you to make the change.
1122

1223
If you would like to contribute to IQS, please visit our wiki page [https://github.com/iqusoft/intel-qs/wiki/Contribute](https://github.com/iqusoft/intel-qs/wiki/Contribute).

0 commit comments

Comments
 (0)