-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding docs that describe how to contribute (#9)
- Loading branch information
1 parent
6b8762a
commit 26f01c7
Showing
2 changed files
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
[ ] This contribution adheres to [CONTRIBUTING.md](https://github.com/ni/nifpga-python/blob/master/CONTRIBUTING.md). | ||
|
||
TODO: Check the above box with an 'x' indicating you've read and followed [CONTRIBUTING.md](https://github.com/ni/nifpga-python/blob/master/CONTRIBUTING.md). | ||
|
||
### What does this Pull Request accomplish? | ||
|
||
TODO: Include high-level description of the changes in this pull request. | ||
|
||
### Why should this Pull Request be merged? | ||
|
||
TODO: Justify why this contribution should be part of the project. | ||
|
||
### What testing has been done? | ||
|
||
TODO: Detail what testing has been done to ensure this submission meets requirements. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Contributing to nifpga-python | ||
|
||
Contributions to nifpga-python are welcome from all! | ||
|
||
nifpga-python is managed via [git](https://git-scm.com), with the canonical upstream | ||
repository hosted on [GitHub](http://github.com/). | ||
|
||
nifpga-python follows a pull-request model for development. If you wish to | ||
contribute, you will need to create a GitHub account, fork this project, push a | ||
branch with your changes to your project, and then submit a pull request. | ||
|
||
See [GitHub's official documentation](https://help.github.com/articles/using-pull-requests/) for more details. | ||
|
||
# Testing | ||
|
||
This project uses [Travis CI](https://travis-ci.org/ni/nifpga-python/). Use it | ||
to test your branch ahead of time and it will also be run on all pull-requests. | ||
|
||
# Developer Certificate of Origin (DCO) | ||
|
||
Developer's Certificate of Origin 1.1 | ||
|
||
By making a contribution to this project, I certify that: | ||
|
||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
|
||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
|
||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
|
||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. | ||
|
||
(taken from [developercertificate.org](http://developercertificate.org/)) | ||
|
||
See [LICENSE](https://github.com/ni/nifpga-python/blob/master/LICENSE) | ||
for details about how nifpga-python is licensed. |