Skip to content

Commit 38746ea

Browse files
docs: Cross reference contributing
.md points to .html on latest .rst points to .md on main (not that it will work before this is merged)
1 parent 9c9b3eb commit 38746ea

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ first time contributing to an open source project, please take a look at the
55
following guide:
66
https://opensource.guide/how-to-contribute/#orienting-yourself-to-a-new-project.
77

8+
Information about the Yosys coding style is available on our Read the Docs:
9+
https://yosys.readthedocs.io/en/latest/yosys_internals/extending_yosys/contributing.html.
810

911
# Using the issue tracker
1012

docs/source/yosys_internals/extending_yosys/contributing.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
Contributing to Yosys
22
=====================
33

4+
.. note::
5+
6+
For information on making a pull request on github, refer to our
7+
|CONTRIBUTING|_ file.
8+
9+
.. |CONTRIBUTING| replace:: :file:`CONTRIBUTING.md`
10+
.. _CONTRIBUTING: https://github.com/YosysHQ/yosys/CONTRIBUTING.md
11+
412
Coding Style
513
------------
614

0 commit comments

Comments
 (0)