Skip to content

Commit 9d759d1

Browse files
authored
update docs (AtsushiSakai#578)
* update docs * update docs
1 parent 094a413 commit 9d759d1

File tree

4 files changed

+44
-12
lines changed

4 files changed

+44
-12
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,6 @@ A clear and concise description of what you expected to happen.
1717
If applicable, add screenshots to help explain your problem.
1818

1919
**Desktop (please complete the following information):**
20-
- Python version (This repo only supports Python 3.7.x or higher).
20+
- Python version (This repo only supports Python 3.9.x or higher).
2121
- Each library version
22+
- OS version

.github/pull_request_template.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
<!--
22
Thanks for contributing a pull request!
3-
Please ensure that your PR satisfies the checklist before submitting:
4-
- [] This project only accept codes for python 3.9 or higher.
5-
- [] If you add a new algorithm sample code, please add a unit test file under `test` dir.
6-
This sample test code might help you : https://github.com/AtsushiSakai/PythonRobotics/blob/master/tests/test_a_star.py
7-
- [] If you fix a bug of existing code please add a test function in the test code to show the issue was solved.
8-
- [] Please fix all issues on CI (All CI should be green), before code review.
3+
Please check this document before submitting:
4+
- [How to contribute](https://pythonrobotics.readthedocs.io/en/latest/how_to_contribute.html#adding-a-new-algorithm-example)
95
106
Note that this is my hobby project; I appreciate your
117
patience during the review process.
@@ -21,3 +17,8 @@ Again, thanks for contributing!
2117

2218
#### Additional information
2319
<!--Any additional information you think is important.-->
20+
21+
#### CheckList
22+
-[] Did you add an unittest for your new example or defect fix?
23+
-[] Did you add documents for your new example?
24+
-[] All CIs are green? (You can check it after submitting)

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -603,19 +603,21 @@ If this project helps your robotics project, please let me know with creating an
603603

604604
Your robot's video, which is using PythonRobotics, is very welcome!!
605605

606-
This is a list of other user's comment and references:[users\_comments](https://github.com/AtsushiSakai/PythonRobotics/blob/master/users_comments.md)
606+
This is a list of user's comment and references:[users\_comments](https://github.com/AtsushiSakai/PythonRobotics/blob/master/users_comments.md)
607607

608608
# Contribution
609609

610-
Any contribution is welcome!!
610+
Any contribution is welcome!!
611+
612+
Please check this document:[How to contribute](https://pythonrobotics.readthedocs.io/en/latest/how_to_contribute.html#)
611613

612614
# Citing
613615

614616
If you use this project's code for your academic work, we encourage you to cite [our papers](https://arxiv.org/abs/1808.10703)
615617

616618
If you use this project's code in industry, we'd love to hear from you as well; feel free to reach out to the developers directly.
617619

618-
# Support
620+
# Supporting this project
619621

620622
If you or your company would like to support this project, please consider:
621623

@@ -627,9 +629,9 @@ If you or your company would like to support this project, please consider:
627629

628630
If you would like to support us in some other way, please contact with creating an issue.
629631

630-
# Sponsors
632+
## Sponsors
631633

632-
## [JetBrains](https://www.jetbrains.com/)
634+
### [JetBrains](https://www.jetbrains.com/)
633635

634636
They are providing a free license of their IDEs for this OSS development.
635637

docs/how_to_contribute_main.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ This sample test code might help you : `test_a_star.py`_.
4848

4949
At the least, try to run the example code without animation in the unit test.
5050

51+
If you want to run the test suites locally, you can use the `runtests.sh` script by just executing it.
52+
5153

5254
.. _`how to write doc`:
5355

@@ -118,6 +120,27 @@ but no detailed algorithm or mathematical description.
118120

119121
This doc `how to write doc`_ can be helpful to write documents.
120122

123+
Supporting this project
124+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
125+
126+
Supporting this project financially is also a great contribution!!.
127+
128+
If you or your company would like to support this project, please consider:
129+
130+
- `Sponsor @AtsushiSakai on GitHub Sponsors`_
131+
132+
- `Become a backer or sponsor on Patreon`_
133+
134+
- `One-time donation via PayPal`_
135+
136+
If you would like to support us in some other way, please contact with creating an issue.
137+
138+
Sponsors
139+
---------
140+
141+
1. `JetBrains`_ : They are providing a free license of their IDEs for this OSS development.
142+
143+
121144
.. _`Python Robotics Docs`: https://pythonrobotics.readthedocs.io/en/latest/
122145
.. _`bug labeled issues`: https://github.com/AtsushiSakai/PythonRobotics/issues?q=is%3Aissue+is%3Aopen+label%3Abug
123146
.. _`tests dir`: https://github.com/AtsushiSakai/PythonRobotics/tree/master/tests
@@ -126,4 +149,9 @@ This doc `how to write doc`_ can be helpful to write documents.
126149
.. _`reStructuredText`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
127150
.. _`doc modules dir`: https://github.com/AtsushiSakai/PythonRobotics/tree/master/docs/modules
128151
.. _`doc README`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/docs/README.md
152+
.. _`JetBrains`: https://www.jetbrains.com/
153+
.. _`Sponsor @AtsushiSakai on GitHub Sponsors`: https://github.com/sponsors/AtsushiSakai
154+
.. _`Become a backer or sponsor on Patreon`: https://www.patreon.com/myenigma
155+
.. _`One-time donation via PayPal`: https://www.paypal.me/myenigmapay/
156+
129157

0 commit comments

Comments
 (0)