Skip to content

Commit 3bfd33e

Browse files
committed
Merge branch 'feature_contribute' into develop
2 parents 85d0a0f + 3cdaee6 commit 3bfd33e

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed

CONTRIBUTORS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Main Committers
2+
====================
3+
4+
- Shinya Takamaeda-Yamazaki (@shtaxxx)
5+
6+
7+
Contributors
8+
====================
9+

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,25 @@ Veriloggen is not a behavior synthesis (or high level synthesis). Veriloggen pro
5151
Veriloggen is not designed for designing a hardware by programmer directly, but is for providing an efficient abstraction to develop a more efficient domain specific language and tools.
5252

5353

54+
Contribute to Veriloggen
55+
==============================
56+
57+
Veriloggen project always welcomes questions, bug reports, feature proposals, and pull requests on [GitHub](https://github.com/PyHDI/veriloggen).
58+
59+
### for questions, bug reports, and feature proposals
60+
61+
Please leave your comment on the [issue tracker](https://github.com/PyHDI/Veriloggen/issues) on GitHub.
62+
63+
### for pull requests
64+
65+
Please check "CONTRIBUTORS.md" for the contributors who provided pull requests.
66+
67+
Veriloggen uses **pytest** for the integration testing. **When you send a pull request, please include a testing example with pytest.**
68+
To write a testing code, please refer the existing testing examples in "tests" directory.
69+
70+
If the pull request code passes all the tests successfully and has no obvious problem, it will be merged to the *develop* branch by the main committers.
71+
72+
5473
Installation
5574
==============================
5675

README.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,34 @@ Veriloggen is not designed for designing a hardware by programmer
5757
directly, but is for providing an efficient abstraction to develop a
5858
more efficient domain specific language and tools.
5959

60+
Contribute to Veriloggen
61+
========================
62+
63+
Veriloggen project always welcomes questions, bug reports, feature
64+
proposals, and pull requests on
65+
`GitHub <https://github.com/PyHDI/veriloggen>`__.
66+
67+
for questions, bug reports, and feature proposals
68+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69+
70+
Please leave your comment on the `issue
71+
tracker <https://github.com/PyHDI/Veriloggen/issues>`__ on GitHub.
72+
73+
for pull requests
74+
~~~~~~~~~~~~~~~~~
75+
76+
Please check “CONTRIBUTORS.md” for the contributors who provided pull
77+
requests.
78+
79+
Veriloggen uses **pytest** for the integration testing. **When you send
80+
a pull request, please include a testing example with pytest.** To write
81+
a testing code, please refer the existing testing examples in “tests”
82+
directory.
83+
84+
If the pull request code passes all the tests successfully and has no
85+
obvious problem, it will be merged to the *develop* branch by the main
86+
committers.
87+
6088
Installation
6189
============
6290

0 commit comments

Comments
 (0)