Skip to content

Commit 557ba5a

Browse files
committed
Merge branch 'feature_contribution' into develop
2 parents b119315 + 70a8d7b commit 557ba5a

File tree

3 files changed

+38
-8
lines changed

3 files changed

+38
-8
lines changed

CONTRIBUTORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Main Committer
1+
Main Committers
22
====================
33

44
- Shinya Takamaeda-Yamazaki (@shtaxxx)

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Note that this software package includes PLY-3.4 in "vparser/ply". The license o
1919
Publication
2020
==============================
2121

22-
If you use Pyverilog in your research, please cite my paper.
22+
If you use Pyverilog in your research, please cite the following paper.
2323

2424
- Shinya Takamaeda-Yamazaki: Pyverilog: A Python-based Hardware Design Processing Toolkit for Verilog HDL, 11th International Symposium on Applied Reconfigurable Computing (ARC 2015) (Poster), Lecture Notes in Computer Science, Vol.9040/2015, pp.451-460, April 2015.
2525
[Paper](http://link.springer.com/chapter/10.1007/978-3-319-16214-0_42)
@@ -53,9 +53,20 @@ You can create your own design analyzer, code translator and code generator of V
5353
Contribute to Pyverilog
5454
==============================
5555

56-
Pyverilog project always welcomes questions, bug reports, feature proposals, and pull requests on GitHub.
56+
Pyverilog project always welcomes questions, bug reports, feature proposals, and pull requests on [GitHub](https://github.com/PyHDI/Pyverilog).
5757

58-
Pyverilog uses pytest for the integration testing. When you send a pull request, please include a test example with pytest.
58+
### for questions, bug reports, and feature proposals
59+
60+
Please leave your comment on the [issue tracker](https://github.com/PyHDI/Pyverilog/issues) on GitHub.
61+
62+
### for pull requests
63+
64+
Please check "CONTRIBUTORS.md" for the contributors who provided pull requests.
65+
66+
Pyverilog uses **pytest** for the integration testing. **When you send a pull request, please include a testing example with pytest.**
67+
To write a testing code, please refer the existing testing examples in "tests" directory.
68+
69+
If the requested codes passes the testing successfully and have no obvious problem, they will be merged to the *develop* branch by the main committers.
5970

6071

6172
Documentation

README.rst

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ license of PLY is BSD.
1818
Publication
1919
===========
2020

21-
If you use Pyverilog in your research, please cite my paper.
21+
If you use Pyverilog in your research, please cite the following paper.
2222

2323
- Shinya Takamaeda-Yamazaki: Pyverilog: A Python-based Hardware Design
2424
Processing Toolkit for Verilog HDL, 11th International Symposium on
@@ -57,10 +57,29 @@ Contribute to Pyverilog
5757
=======================
5858

5959
Pyverilog project always welcomes questions, bug reports, feature
60-
proposals, and pull requests on GitHub.
60+
proposals, and pull requests on
61+
`GitHub <https://github.com/PyHDI/Pyverilog>`__.
6162

62-
Pyverilog uses pytest for the integration testing. When you send a pull
63-
request, please include a test example with pytest.
63+
for questions, bug reports, and feature proposals
64+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65+
66+
Please leave your comment on the `issue
67+
tracker <https://github.com/PyHDI/Pyverilog/issues>`__ on GitHub.
68+
69+
for pull requests
70+
~~~~~~~~~~~~~~~~~
71+
72+
Please check “CONTRIBUTORS.md” for the contributors who provided pull
73+
requests.
74+
75+
Pyverilog uses **pytest** for the integration testing. **When you send a
76+
pull request, please include a testing example with pytest.** To write a
77+
testing code, please refer the existing testing examples in “tests”
78+
directory.
79+
80+
If the requested codes passes the testing successfully and have no
81+
obvious problem, they will be merged to the *develop* branch by the main
82+
committers.
6483

6584
Documentation
6685
=============

0 commit comments

Comments
 (0)