|
1 | 1 | # Contribution Guidelines |
2 | 2 |
|
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. |
4 | 4 |
|
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). |
6 | 40 |
|
7 | 41 | ## Pull Requests |
8 | 42 |
|
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. |
10 | 44 |
|
11 | 45 | ### Styling |
12 | 46 |
|
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/). |
14 | 53 |
|
15 | 54 | ### Documentation |
16 | 55 |
|
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. |
18 | 57 |
|
19 | 58 | ### Testing |
20 | 59 |
|
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: |
24 | 61 |
|
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) |
0 commit comments