Commentary: Update CONTRIBUTING and internals xrefs (#4043)

This commit is contained in:
Wilson Snyder 2023-03-18 10:23:19 -04:00
parent d60a3e2b66
commit ba9e141fae
2 changed files with 25 additions and 14 deletions

View File

@ -10,9 +10,12 @@ contributions flow more efficiently.
Did you find a bug? Did you find a bug?
------------------- -------------------
- Please **Ensure the bug was not already reported** by searching - Please **ensure the bug was not already reported** by searching
`Verilator Issues <https://verilator.org/issues>`__. `Verilator Issues <https://verilator.org/issues>`__.
- Please **download the latest development GitHub version**, build, and see
if the issue has been fixed.
- If you're unable to find an open issue addressing the problem, `open a - If you're unable to find an open issue addressing the problem, `open a
new Verilator issue <https://verilator.org/issues/new>`__. new Verilator issue <https://verilator.org/issues/new>`__.
@ -20,21 +23,28 @@ Did you find a bug?
demonstrating the bug and expected behavior that is not occurring. demonstrating the bug and expected behavior that is not occurring.
- The ideal example works against other simulators, and is in the - The ideal example works against other simulators, and is in the
test_regress/t test format, as described in `docs/internals test_regress/t test format, as described in
<internals.rst>`__. `Verilator Internals Documentation
<https://github.com/verilator/verilator/blob/master/docs/internals.rst>`__.
Did you write a patch that fixes a bug? Did you write a patch that fixes a bug?
--------------------------------------- ---------------------------------------
- Please `Open a new issue <https://verilator.org/issues/new>`__. - Please `Open a new Verilator issue <https://verilator.org/issues/new>`__
if there is not one already describing the bug.
- You may attach a patch to the issue, or (preferred) may request a - Please `Open a Verilator pull request
GitHub pull request. <https://github.com/verilator/verilator/pulls>`__.
- See the coding conventions, and other developer information in
``docs/internals.rst`` in the distribution, or as rendered at
`Verilator Internals Documentation
<https://github.com/verilator/verilator/blob/master/docs/internals.rst>`__.
- Verilator uses GitHub Actions to provide continuous integration. You - Verilator uses GitHub Actions to provide continuous integration. You
may want to enable Actions on your GitHub branch to ensure your changes may want to enable Actions on your GitHub branch to ensure your changes
keep the tests passing. See `docs/internals <internals.rst>`__. keep the tests passing.
- Your source-code contributions must be certified as open source, - Your source-code contributions must be certified as open source,
under the `Developer Certificate of under the `Developer Certificate of
@ -56,13 +66,10 @@ Did you write a patch that fixes a bug?
contribution. contribution.
- Your test contributions are generally considered released into the - Your test contributions are generally considered released into the
Creative Commons Public Domain (CC0), unless you request otherwise or Creative Commons Public Domain (CC0), unless you request otherwise, or
put a GNU/Artistic license on your file. put a GNU/Artistic license on your file.
- Most important is we get your patch. If you'd like to clean up - Most important is we get your patch.
indentation and related issues ahead of our feedback, that is
appreciated; please see the coding conventions in `docs/internals
<internals.rst>`__.
Do you have questions? Do you have questions?

View File

@ -191,6 +191,7 @@ Laurens
Lavino Lavino
Leber Leber
Leendert Leendert
Lem
Lesik Lesik
Liland Liland
Liu Liu
@ -301,6 +302,7 @@ Solomatnikov
Solt Solt
Southwell Southwell
Srini Srini
Srinivasan
Stamness Stamness
Stephane Stephane
Stoddard Stoddard
@ -349,6 +351,7 @@ Vdeeptemp
Vdly Vdly
Vemumtab Vemumtab
Vemuri Vemuri
Venkataramanan
Veriable Veriable
Verialted Verialted
Verilate Verilate
@ -854,6 +857,7 @@ svdpi
swrite swrite
sys sys
systemc systemc
tenghtt
testbench testbench
threadsafe threadsafe
threashold threashold