@@ -17,7 +17,7 @@ Please follow the steps below and be sure that your contribution complies with o
...
@@ -17,7 +17,7 @@ Please follow the steps below and be sure that your contribution complies with o
2. Clone the fork to your local computer using *git clone*. Checkout the branch you want to work on.
2. Clone the fork to your local computer using *git clone*. Checkout the branch you want to work on.
3. Please install <a href="https://pre-commit.com/" target="_blank">pre-commit</a> to ensure your code is formatted to our style guidelines. The hooks we use for pre-commit can be found in <a href="https://github.com/Xilinx/finn/blob/master/.pre-commit-config.yaml" target="_blank">this file</a>
3. Please install <a href="https://pre-commit.com/" target="_blank">pre-commit</a> to ensure your code is formatted to our style guidelines. The hooks we use for pre-commit can be found in <a href="https://github.com/Xilinx/finn/blob/main/.pre-commit-config.yaml" target="_blank">this file</a>
4. Modify the Python source code, Jupyter notebooks and Sphinx documentation etc. as needed.
4. Modify the Python source code, Jupyter notebooks and Sphinx documentation etc. as needed.
...
@@ -26,7 +26,7 @@ Please follow the steps below and be sure that your contribution complies with o
...
@@ -26,7 +26,7 @@ Please follow the steps below and be sure that your contribution complies with o
6. 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.
6. 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.
7. Submit a pull request by clicking the *pull request* button on your GitHub repo:
7. Submit a pull request by clicking the *pull request* button on your GitHub repo:
1. The <a href="https://github.com/Xilinx/finn" target="_blank">master branch</a> should always be treated as stable and clean. Only hot fixes are allowed to be pull-requested. The hot fix is supposed to be very important such that without this fix, a lot of things will break.
1. The <a href="https://github.com/Xilinx/finn" target="_blank">main branch</a> should always be treated as stable and clean. Only hot fixes are allowed to be pull-requested. The hot fix is supposed to be very important such that without this fix, a lot of things will break.
2. For new features, smaller bug fixes, doc updates, and many other fixes, users should pull request against the <a href="https://github.com/Xilinx/finn/tree/dev" target="_blank">development branch</a>.
2. For new features, smaller bug fixes, doc updates, and many other fixes, users should pull request against the <a href="https://github.com/Xilinx/finn/tree/dev" target="_blank">development branch</a>.
3. We will review your contribution and, if any additional fixes or modifications are
3. We will review your contribution and, if any additional fixes or modifications are
