From fa995b9f66f09258523ea5dcebb78366ab0a5526 Mon Sep 17 00:00:00 2001 From: Atsushi Sakai Date: Thu, 8 Nov 2018 21:36:21 +0900 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..fd41946b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing to Python + +:+1::tada: First of off, thanks very much for taking the time to contribute! :tada::+1: + +The following is a set of guidelines for contributing to PythonRobotics. + +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.6.x or higher. + +We will not accept a PR for Python 2.x.