Skip to content

Commit

Permalink
docs: Cross reference contributing
Browse files Browse the repository at this point in the history
.md points to .html on latest
.rst points to .md on main (not that it will work before this is merged)
  • Loading branch information
KrystalDelusion committed Jan 25, 2025
1 parent c6bbbfa commit 73da096
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ first time contributing to an open source project, please take a look at the
following guide:
https://opensource.guide/how-to-contribute/#orienting-yourself-to-a-new-project.

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

# Using the issue tracker

Expand Down
8 changes: 8 additions & 0 deletions docs/source/yosys_internals/extending_yosys/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Contributing to Yosys
=====================

.. note::

For information on making a pull request on github, refer to our
|CONTRIBUTING|_.

.. |CONTRIBUTING| replace:: :file:`CONTRIBUTING.md`
.. _CONTRIBUTING: https://github.com/YosysHQ/yosys/CONTRIBUTING.md

Coding Style
------------

Expand Down

0 comments on commit 73da096

Please sign in to comment.