From ba9e141faebe66c9fe6f5d9548334cefd427d8d7 Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Sat, 18 Mar 2023 10:23:19 -0400 Subject: [PATCH] Commentary: Update CONTRIBUTING and internals xrefs (#4043) --- docs/CONTRIBUTING.rst | 35 +++++++++++++++++++++-------------- docs/spelling.txt | 4 ++++ 2 files changed, 25 insertions(+), 14 deletions(-) diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 1e81842ad..c7a4de79d 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -10,9 +10,12 @@ contributions flow more efficiently. 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 `__. +- 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 new Verilator issue `__. @@ -20,21 +23,28 @@ Did you find a bug? demonstrating the bug and expected behavior that is not occurring. - 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 + `Verilator Internals Documentation + `__. Did you write a patch that fixes a bug? --------------------------------------- -- Please `Open a new issue `__. +- Please `Open a new Verilator issue `__ + if there is not one already describing the bug. -- You may attach a patch to the issue, or (preferred) may request a - GitHub pull request. +- Please `Open a Verilator pull request + `__. - - Verilator uses GitHub Actions to provide continuous integration. You - may want to enable Actions on your GitHub branch to ensure your changes - keep the tests passing. See `docs/internals `__. +- See the coding conventions, and other developer information in + ``docs/internals.rst`` in the distribution, or as rendered at + `Verilator Internals Documentation + `__. + +- Verilator uses GitHub Actions to provide continuous integration. You + may want to enable Actions on your GitHub branch to ensure your changes + keep the tests passing. - Your source-code contributions must be certified as open source, under the `Developer Certificate of @@ -56,13 +66,10 @@ Did you write a patch that fixes a bug? contribution. - 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. -- Most important is we get your patch. If you'd like to clean up - indentation and related issues ahead of our feedback, that is - appreciated; please see the coding conventions in `docs/internals - `__. +- Most important is we get your patch. Do you have questions? diff --git a/docs/spelling.txt b/docs/spelling.txt index 9098225a7..7d6a7c5d5 100644 --- a/docs/spelling.txt +++ b/docs/spelling.txt @@ -191,6 +191,7 @@ Laurens Lavino Leber Leendert +Lem Lesik Liland Liu @@ -301,6 +302,7 @@ Solomatnikov Solt Southwell Srini +Srinivasan Stamness Stephane Stoddard @@ -349,6 +351,7 @@ Vdeeptemp Vdly Vemumtab Vemuri +Venkataramanan Veriable Verialted Verilate @@ -854,6 +857,7 @@ svdpi swrite sys systemc +tenghtt testbench threadsafe threashold