|
1 | 1 | # How to Contribute
|
2 | 2 |
|
3 |
| -We'd love to accept your patches and contributions to this project. |
| 3 | +We'd love to accept your patches and contributions to this project. |
4 | 4 | There are just a few small guidelines you need to follow.
|
5 | 5 |
|
6 | 6 | ## Discussion
|
7 | 7 |
|
8 |
| -Share your proposal via [Github Issues](https://github.com/fastmachinelearning/hls4ml/issues). |
9 |
| -If you are looking for some issues to get started with, we have a list of [good first issues](https://github.com/fastmachinelearning/hls4ml/labels/good%20first%20issue) in the issue tracker. |
| 8 | +Share your proposal via [GitHub Issues](https://github.com/fastmachinelearning/hls4ml/issues). |
| 9 | +If you are looking for some issues to get started with, we have a list of [good first issues](https://github.com/fastmachinelearning/hls4ml/labels/good%20first%20issue) in the issue tracker. |
10 | 10 | We also welcome submissions to improve the documentation.
|
11 | 11 |
|
12 | 12 | ## Pull Request
|
13 | 13 |
|
14 |
| -All submissions, including submissions by project members, require review. |
15 |
| -We use GitHub pull requests for this purpose. |
| 14 | +All submissions, including submissions by project members, require review. |
| 15 | +We use GitHub pull requests for this purpose. |
16 | 16 | Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
|
17 | 17 |
|
18 | 18 | 1. In the pull request description, clearly document all changes made and the expected behavior.
|
19 | 19 | 1. If you are introducing new functionality, add at least one unit test under the `test` folder and make sure it passes before you submit the pull request.
|
20 | 20 | 1. Similarly, if you are fixing a bug, add at least one unit test under the `test` folder such that the master branch fails the test and your branch passes the test.
|
| 21 | +1. Install and run `pre-commit` on the files that you have edited. We are adiabatically turning on linting for the full repository (see [#678](https://github.com/fastmachinelearning/hls4ml/pull/678)). |
21 | 22 | 1. Submit the pull request to the [main](https://github.com/fastmachinelearning/hls4ml) branch.
|
22 | 23 |
|
23 | 24 | ## Code Reviews
|
24 | 25 |
|
25 |
| -We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you. |
26 |
| -When accepted, your pull request will be merged to the repository. |
| 26 | +We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you. |
| 27 | +When accepted, your pull request will be merged to the repository. |
27 | 28 |
|
28 | 29 | ## Code of Conduct
|
29 | 30 |
|
|
0 commit comments