github/PythonRobotics
1
1
Fork 0
mirror of https://github.com/AtsushiSakai/PythonRobotics.git synced 2026-01-10 12:58:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Atsushi Sakai
2025-02-07 13:42:56 +09:00
committed by GitHub
parent 9936f34463
commit 15e1068392
1 changed files with 3 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@@ -1,23 +1,5 @@
# Contributing to Python # Contributing
:+1::tada: First of off, thanks very much for taking the time to contribute! :tada::+1: :+1::tada: First of all, thank you very much for taking the time to contribute! :tada::+1:
The following is a set of guidelines for contributing to PythonRobotics. Please check this document for contribution: [How to contribute — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/modules/0_getting_started/3_how_to_contribute.html)
These are mostly guidelines, not rules.
Use your best judgment, and feel free to propose changes to this document in a pull request.
# Before contributing
## Taking a look at the paper.
Please check this paper to understand the philosophy of this project.
- [\[1808\.10703\] PythonRobotics: a Python code collection of robotics algorithms](https://arxiv.org/abs/1808.10703) ([BibTeX](https://github.com/AtsushiSakai/PythonRoboticsPaper/blob/master/python_robotics.bib))
## Check your Python version.
We only accept a PR for Python 3.8.x or higher.
We will not accept a PR for Python 2.x.