@@ -2,9 +2,18 @@ How To Contribute
22=================
33
44This document describes how to contribute this project.
5+ There are several ways to contribute to this project as below:
6+
7+ #. `Adding a new algorithm example `_
8+ #. `Reporting and fixing a defect `_
9+ #. `Adding missed documentations for existing examples `_
10+ #. `Supporting this project `_
11+
12+
13+ .. _`Adding a new algorithm example` :
514
615Adding a new algorithm example
7- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
817
918This is a step by step manual to add a new algorithm example.
1019
@@ -67,9 +76,16 @@ Please check other documents for details.
6776
6877You can build the doc locally based on `doc README `_.
6978
70- Note that the `reStructuredText `_ based doc should only focus on the mathematics and the algorithm of the example.
79+ For creating a gif animation, you can use this tool: `matplotrecorder `_.
80+
81+ The created gif file should be stored in the `PythonRoboticsGifs `_ repository,
82+ so please create a PR to add it and refer to it in the doc.
83+
84+ Note that the `reStructuredText `_ based doc should only focus on the
85+ mathematics and the algorithm of the example.
7186
72- Documentations related codes should be in the python script as the header comments of the script or docstrings of each function.
87+ Documentations related codes should be in the python script as the header
88+ comments of the script or docstrings of each function.
7389
7490
7591.. _`submit a pull request` :
@@ -92,6 +108,9 @@ After that, I will start the review.
92108
93109Note that this is my hobby project; I appreciate your patience during the review process.
94110
111+
112+
113+ .. _`Reporting and fixing a defect` :
95114
96115Reporting and fixing a defect
97116^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -115,19 +134,24 @@ in the test code to show the issue was solved.
115134This doc `submit a pull request `_ can be helpful to submit a pull request.
116135
117136
137+ .. _`Adding missed documentations for existing examples` :
138+
118139Adding missed documentations for existing examples
119140^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
120141
121142Adding the missed documentations for existing examples is also great contribution.
122143
123144If you check the `Python Robotics Docs `_, you can notice that some of the examples
124- only have a simulation gif or short overview descriptions,
145+ only have a simulation gif or short overview descriptions or just TBD. ,
125146but no detailed algorithm or mathematical description.
147+ These documents needs to be improved.
126148
127149This doc `how to write doc `_ can be helpful to write documents.
128150
151+ .. _`Supporting this project` :
152+
129153Supporting this project
130- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
154+ ^^^^^^^^^^^^^^^^^^^^^^^^
131155
132156Supporting this project financially is also a great contribution!!.
133157
@@ -141,10 +165,12 @@ If you or your company would like to support this project, please consider:
141165
142166If you would like to support us in some other way, please contact with creating an issue.
143167
144- Sponsors
145- ---------
168+ Current Major Sponsors
169+ -----------------------
170+
171+ #. `JetBrains `_ : They are providing a free license of their IDEs for this OSS development.
172+ #. `1Password `_ : They are providing a free license of their 1Password team license for this OSS project.
146173
147- 1. `JetBrains `_ : They are providing a free license of their IDEs for this OSS development.
148174
149175
150176.. _`Python Robotics Docs` : https://atsushisakai.github.io/PythonRobotics
@@ -160,5 +186,8 @@ Sponsors
160186.. _`Sponsor @AtsushiSakai on GitHub Sponsors` : https://github.com/sponsors/AtsushiSakai
161187.. _`Become a backer or sponsor on Patreon` : https://www.patreon.com/myenigma
162188.. _`One-time donation via PayPal` : https://www.paypal.com/paypalme/myenigmapay/
189+ .. _`1Password` : https://github.com/1Password/for-open-source
190+ .. _`matplotrecorder` : https://github.com/AtsushiSakai/matplotrecorder
191+ .. _`PythonRoboticsGifs` : https://github.com/AtsushiSakai/PythonRoboticsGifs
163192
164193
0 commit comments