Skip to content

Commit e6d5299

Browse files
authored
Add a Contributor Agreement (#42)
### What kind of change does this PR introduce? * Adds a contributor licensing agreement to satisfy conditions of the Artistic License v2.0 * Updates the CONTRIBUTING.md file to provide relevant information (removing lorem ipsum stand-in text) * Adds a warning for first-time contributors to agree to the contributor licensing agreement ### Does this PR introduce a breaking change? * No. The project now follows the licensing recommendations much closer to the letter.
1 parent 5358172 commit e6d5299

File tree

3 files changed

+111
-9
lines changed

3 files changed

+111
-9
lines changed

.github/workflows/first_pull_request.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,9 @@ jobs:
4242
It appears that this is your first Pull Request. To give credit where it's due, we ask that you add your information to the \`AUTHORS.md\` and \`.zenodo.json\`:
4343
- [ ] The relevant author information has been added to \`AUTHORS.md\` and \`.zenodo.json\`
4444
45+
We also require that you sign our [Contributor License Agreement](https://github.com/CSHS-CWRA/RavenHydroFramework/blob/main/contributor-licensing-agreement.txt) before we can merge your code.
46+
Please add the following line to your Pull Request description:
47+
- [x] I have read and agree to the terms of the Contributor License Agreement.
48+
4549
Please make sure you've read our [contributing guide](CONTRIBUTING.md). We look forward to reviewing your Pull Request shortly ✨`
4650
})

CONTRIBUTING.md

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,64 @@
11
# Contribution Guidelines
22

3-
## Contributor Licensing Agreement
3+
Thank you for considering contributing to the Raven Hydrological Modelling Framework! By participating in this project, you agree to abide by the following terms and conditions.
44

5-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Mus mauris vitae ultricies leo integer malesuada nunc vel. Cras pulvinar mattis nunc sed blandit libero volutpat sed. Elit eget gravida cum sociis natoque. Nunc mattis enim ut tellus elementum sagittis vitae et leo. Urna neque viverra justo nec ultrices dui sapien eget mi. Proin nibh nisl condimentum id venenatis a condimentum vitae. Scelerisque eleifend donec pretium vulputate sapien. Venenatis tellus in metus vulputate eu. Auctor urna nunc id cursus metus aliquam. Leo vel orci porta non pulvinar neque laoreet suspendisse. Facilisi cras fermentum odio eu feugiat pretium nibh ipsum consequat.
5+
## Contribution Process
6+
7+
1. Fork the repository and create your branch from `main`.
8+
2. Make your changes.
9+
3. Ensure your code adheres to the project's coding standards.
10+
4. Update documentation if necessary.
11+
5. Submit a pull request.
12+
13+
## License
14+
15+
By contributing to this project, you agree that your contributions will be licensed under the [Artistic License v2.0](https://github.com/CSHS-CWRA/RavenHydroFramework/blob/main/LICENSE).
16+
17+
## Contributor Licensing Agreement (CLA)
18+
19+
Before we can accept your contributions, you need to agree to our Contributor License Agreement (CLA). This agreement helps us ensure that we can freely distribute your contributions as part of the project.
20+
21+
### Summary of the CLA
22+
23+
* Grant of Copyright License: You grant us a perpetual, worldwide, non-exclusive, royalty-free license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute your contributions and derivative works thereof under the Artistic License v2.0.
24+
* Grant of Patent License: You grant us a perpetual, worldwide, non-exclusive, royalty-free patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer your contributions under certain conditions.
25+
* Source of Contribution: You represent that your contributions are your original creation and that you have the right to grant these licenses.
26+
* Rights in Contributions: You confirm that you have the necessary rights and permissions to make your contributions, including any required approvals from your employer.
27+
* Representations and Warranties: You represent that you are legally entitled to grant the above licenses and that your contributions are your original creation.
28+
29+
### Full Agreement
30+
31+
The full text of the CLA can be found [here](https://github.com/CSHS-CWRA/RavenHydroFramework/blob/main/contributor-licensing-agreement.txt).
32+
33+
### How to Agree to the CLA
34+
35+
To agree to the CLA, you must sign the checkbox pertaining to it in your first pull request:
36+
37+
" - [x] I have read and agree to the terms of the Contributor License Agreement."
38+
39+
Alternatively, you can sign the CLA by submitting the completed CLA form to [James Craig](mailto:[email protected]?subject=RAVEN-CLA).
640

741
## Pull Requests
842

9-
Sagittis vitae et leo duis ut diam quam nulla. Scelerisque varius morbi enim nunc faucibus a pellentesque sit. Aliquet nec ullamcorper sit amet risus nullam eget felis eget. Cras adipiscing enim eu turpis. Purus sit amet volutpat consequat mauris nunc congue nisi vitae. Varius morbi enim nunc faucibus a. Blandit volutpat maecenas volutpat blandit aliquam etiam erat velit scelerisque. Aliquet enim tortor at auctor. Est placerat in egestas erat imperdiet sed euismod nisi porta. Metus aliquam eleifend mi in nulla posuere sollicitudin aliquam. Volutpat consequat mauris nunc congue nisi.
43+
When opening a Pull Request, we ask that contributors label their changes with an appropriate title and provide descriptions of the changes that they wish to implement, whether those changes may cause disruptions to the normal behaviour of the project ("Breaking Changes"), and provide links to any pertinent GitHub Issues, Pull Requests, or other information.
1044

1145
### Styling
1246

13-
Amet purus gravida quis blandit turpis cursus in hac. Blandit volutpat maecenas volutpat blandit aliquam. Aliquam sem fringilla ut morbi. Nisl vel pretium lectus quam id leo in.
47+
This project employs a handful of code styling conventions. Those currently in use are:
48+
49+
* No whitepaces at the end of lines.
50+
* All files must end with a newline ('\n').
51+
52+
Coding standards are enforced via [pre-commit](https://pre-commit.com/), with automatic corrections performed via [pre-commit CI](https://pre-commit.ci/).
1453

1554
### Documentation
1655

17-
Elit scelerisque mauris pellentesque pulvinar pellentesque habitant morbi tristique senectus. Tortor consequat id porta nibh venenatis cras sed felis. Purus viverra accumsan in nisl nisi scelerisque.
56+
Documentation for the Raven Hydrological Modelling Framework can be found at https://raven.uwaterloo.ca/Downloads.html.
1857

1958
### Testing
2059

21-
Rutrum tellus pellentesque eu tincidunt tortor aliquam. Rhoncus urna neque viverra justo nec ultrices dui sapien eget. Mattis enim ut tellus elementum.
22-
23-
### Commit Messages
60+
This library does not currently use testing. It is expected that all new contributions should compile for the following architectures:
2461

25-
Condimentum vitae sapien pellentesque habitant morbi tristique senectus. Mauris augue neque gravida in fermentum et sollicitudin ac. Sed turpis tincidunt id aliquet risus feugiat.
62+
- Linux (x86_64)
63+
- Windows (x86_64)
64+
- macOS (x86_64, ARM64)
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
Contributor License Agreement (CLA)
2+
3+
Project Name: Raven Hydrological Modelling Framework
4+
5+
Version: X.Y.Z
6+
7+
Effective Date: YYYY-MM-DD
8+
9+
You (the "Contributor") agree to the following terms for your present and future contributions submitted to the project named above (the "Project").
10+
11+
Definitions:
12+
"Contribution" means any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the Project for inclusion in, or documentation of, any of the products owned or managed by the Project (the "Work").
13+
"You" (or "Your") shall mean the individual or legal entity making a Contribution to the Project.
14+
15+
Grant of Copyright License:
16+
You hereby grant to the Project, and to recipients of software distributed by the Project, a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works under the terms of the Artistic License v2.0.
17+
18+
Grant of Patent License:
19+
You hereby grant to the Project, and to recipients of software distributed by the Project, a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that Your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
20+
21+
Source of Contribution:
22+
You represent that each of Your Contributions is Your original creation (see section 6 for submissions on behalf of others).
23+
You represent that Your Contribution submissions include complete details of any third-party licenses or other restrictions (including, but not limited to, related patents and trademarks) of which You are personally aware and which are associated with any part of Your Contributions.
24+
25+
Rights in Contributions:
26+
You are legally entitled to grant the above licenses. If Your employer(s) has rights to intellectual property that You create that includes Your Contributions, You represent that You have received permission to make Contributions on behalf of that employer, that Your employer has waived such rights for Your Contributions to the Project, or that Your employer has executed a separate Corporate CLA with the Project.
27+
28+
Representations and Warranties:
29+
You represent that You are legally entitled to grant the above license.
30+
You represent that each of Your Contributions is Your original creation (see section 6 for submissions on behalf of others).
31+
You represent that Your Contribution submissions include complete details of any third-party licenses or other restrictions (including, but not limited to, related patents and trademarks) of which You are personally aware and which are associated with any part of Your Contributions.
32+
33+
Support:
34+
You understand and agree that the Project is under no obligation to provide maintenance, support, or updates for Your Contributions.
35+
36+
Signatures:
37+
By making a Contribution to the Project, You accept and agree to the terms of this Agreement for Your present and future Contributions submitted to the Project.
38+
39+
Signatories:
40+
41+
Contributor:
42+
43+
Name: ____________________
44+
45+
Title: ____________________
46+
47+
Signature: ____________________
48+
49+
Date: ____________________
50+
51+
Project:
52+
53+
Name: ____________________
54+
55+
Title: ____________________
56+
57+
Signature: ____________________
58+
59+
Date: ____________________

0 commit comments

Comments
 (0)