The-OpenROAD-Project/OpenLane
1
0
Fork 0
mirror of https://github.com/The-OpenROAD-Project/OpenLane.git synced 2026-05-29 00:23:55 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

[DOC] refine the contributing documentation based on the latest updates

Browse Source 
[skip travis]
This commit is contained in:
agorararmard
2021-02-02 00:28:43 +02:00
parent a4dee4ccd4
commit 1a2cf14e29
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@@ -5,8 +5,9 @@ just a few small guidelines you need to follow.
## Submission and Testing Process
- Submit a Pull Request to the [develop](https://github.com/efabless/openlane/tree/develop) branch only. <br> Check [Code Reviews](#code_reviews) for more details.
- Submit a Pull Request to the [master](https://github.com/efabless/openlane/tree/master) branch only. <br> Check [Code Reviews](#code_reviews) for more details.
- Our CI that would test your PR once submitted, yet it would be nice for you to run a couple of tests from your end to shorten the cycle of reviews. For that purpose, you can use:
- `make fastest_test_set`: to run the same test set that the basic CI uses, which will be used to evaluate your Pull Request.
- [This](./regression_results/README.md) for custom test sets. (check the `-b` flag).
- `make test`: tests the flow against one design `$TEST_DESIGN`. The default is `spm`.
- `make regression_test`: tests the flow against all available designs and compares the resulting statistics with benchmark results and produces a human readable report and summary.