riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

CONTRIBUTING.md: Move PR link

This commit is contained in:
Krystine Sherwin 2025-01-17 15:28:39 +13:00
parent eaebf6ab02
commit c6bbbfaa61
No known key found for this signature in database
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@ -30,21 +30,21 @@ in Yosys can be helpful for this process.
# Using pull requests # Using pull requests
If you are working on something to add to Yosys, or fix something that isn't If you are working on something to add to Yosys, or fix something that isn't
working quite right, make a PR! An open PR, even as a draft, tells everyone working quite right, make a [PR](https://github.com/YosysHQ/yosys/pulls)! An
that you're working on it and they don't have to. It can also be a useful way open PR, even as a draft, tells everyone that you're working on it and they
to solicit feedback on in-progress changes. See below to find the best way to don't have to. It can also be a useful way to solicit feedback on in-progress
[ask us questions](#asking-questions). changes. See below to find the best way to [ask us
questions](#asking-questions).
In general, all changes to the code are done as a In general, all changes to the code are done as a PR, with [Continuous
[PR](https://github.com/YosysHQ/yosys/pulls), with [Continuous Integration Integration (CI)](https://github.com/YosysHQ/yosys/actions) tools that
(CI)](https://github.com/YosysHQ/yosys/actions) tools that automatically run the automatically run the full suite of tests compiling and running Yosys. Please
full suite of tests compiling and running Yosys. Please make use of this! If make use of this! If you're adding a feature: add a test! Not only does it
you're adding a feature: add a test! Not only does it verify that your feature verify that your feature is working as expected, but it can also be a handy way
is working as expected, but it can also be a handy way for people to see how the for people to see how the feature is used. If you're fixing a bug: add a test!
feature is used. If you're fixing a bug: add a test! If you can, do this If you can, do this first; it's okay if the test starts off failing - you
first; it's okay if the test starts off failing - you already know there is a already know there is a bug. CI also helps to make sure that your changes still
bug. CI also helps to make sure that your changes still work under a range of work under a range of compilers, settings, and targets.
compilers, settings, and targets.
### Labels ### Labels