CONTRIBUTING.md 1.78 KB
Newer Older
1
2
## Contribute to OpenTAP

Stefan Holst's avatar
Stefan Holst committed
3
Thank you for your interest in contributing to OpenTAP. Contributions includes feature enhancement request, issue reporting, bug fixing...
Michael Dieudonne's avatar
Michael Dieudonne committed
4

Stefan Holst's avatar
Stefan Holst committed
5
This guide details how to contribute to OpenTAP in a way that is efficient for everyone.
6
7
8

## Contributor license agreement

Michael Dieudonne's avatar
Michael Dieudonne committed
9
OpenTAP requires contributors to sign a contribution license agreement (CLA). 
Stefan Holst's avatar
Stefan Holst committed
10
You can find the CLA [here](https://www.opentap.io/docs/OpenTAP%20Contributor%20License%20Agreement%20v2.pdf).
Michael Dieudonne's avatar
Michael Dieudonne committed
11
The CLA can be signed by an individual or a company. For companies, please add the company name and have a legal authorized representative endorsing the document.
12

Stefan Holst's avatar
Stefan Holst committed
13
*  By submitting code as an individual you agree to the individual contributor license agreement.
14

Stefan Holst's avatar
Stefan Holst committed
15
*  By submitting code as an entity you agree to the corporate contributor license agreement.
16

Stefan Holst's avatar
Stefan Holst committed
17
Send the signed CLA to [CLA@opentap.io](mailto:CLA@opentap.io) together with your Gitlab username and email address, and we will promote you to a developer role in the OpenTAP project.
Michael Dieudonne's avatar
Michael Dieudonne committed
18

19
20
## Contibuting Code   
   
21
Once you have signed the CLA and have been added to the project, we welcome merge requests with fixes and improvements to OpenTAP code or documentation.
22

Stefan Holst's avatar
Stefan Holst committed
23
In the issue tracker, the label `Accepting Merge Requests` denotes issues that we agree is a good idea and would really like merge requests for, but other improvements are also most welcome.
24

Stefan Holst's avatar
Stefan Holst committed
25
Issues labeled `To be Discussed` needs futher discussion. Try to resolve these discussions, and get the label removed, before starting to work on these issues.
26

27
28
29
30
Once you have identified an issue:   
1. Assign it to yourself   
2. Create a new branch using the Gitlab recommended syntax: issueNumber-issue-description   
3. Commit changes   
31
4. Open a Merge Request on the master branch at https://gitlab.com/OpenTAP/opentap