|
| 1 | +# Contributing to the libIIO |
| 2 | + |
| 3 | +When contributing to this repository, please first discuss the change you wish to make via the |
| 4 | +[issue tracker](https://github.com/analogdevicesinc/libiio/issues) before making a pull request. |
| 5 | + |
| 6 | +Please note we have a code of conduct, please follow it in all your interactions with the project. |
| 7 | + |
| 8 | +The [libIIO repository](https://github.com/analogdevicesinc/libiio) is a aggregate of a library |
| 9 | +and separate applications/programs/examples and doc which use that library: |
| 10 | +* the libiio library (which is released and distributed under the LGPL 2.0 or greater license) and |
| 11 | +* examples and test code (which is released and distributed under the GPL 2.1 or greater license). |
| 12 | +* groff source for man pages are distributed under the GPL 2.1 or greater. |
| 13 | + |
| 14 | +Any pull requests will be covered by one of these licenses. |
| 15 | + |
| 16 | +## Pull Request Checklist |
| 17 | + |
| 18 | +1. Commit message includes a "Signed-off-by: [name] < email >" to the commit message. |
| 19 | + This ensures you have the rights to submit your code, by agreeing to the |
| 20 | + [Developer Certificate of Origin](https://developercertificate.org/). If you can not agree to |
| 21 | + the DCO, don't submit a pull request, as we can not accept it. |
| 22 | +2. Commit should be "atomic", ie : should do one thing only. A pull requests should only contain |
| 23 | + multiple commits if that is required to fix the bug or implement the feature. |
| 24 | +3. Commits should have good commit messages. Check out [The git Book](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project) |
| 25 | + for some pointers, and tools to use. |
| 26 | +4. The project must build and run on MacOS, Windows, and Linux. This is checked on every pull request by the |
| 27 | + continuous integration system, things that fail to build can not be merged. |
| 28 | + |
| 29 | +## Pull Request Process |
| 30 | + |
| 31 | +1. Make a fork, if you are not sure on how to make a fork, check out [GitHub help](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) |
| 32 | +2. Make a Pull Request, if you are not sure on how to make a pull request, check out [GitHub help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) |
| 33 | +3. Before a Pull Request can be merged, it must be reviewd by at least one reviewer, and tested on as |
| 34 | + many different IIO devices as possible. If you have tested it, you can indicated that in your commit |
| 35 | + message. |
| 36 | + |
0 commit comments