Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
AtsushiSakai committed Nov 8, 2018
2 parents 6262ef8 + c381f8d commit 38d901c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![Build Status](https://travis-ci.org/AtsushiSakai/PythonRobotics.svg?branch=master)](https://travis-ci.org/AtsushiSakai/PythonRobotics)
[![Documentation Status](https://readthedocs.org/projects/pythonrobotics/badge/?version=latest)](https://pythonrobotics.readthedocs.io/en/latest/?badge=latest)
[![Build status](https://ci.appveyor.com/api/projects/status/sb279kxuv1be391g?svg=true)](https://ci.appveyor.com/project/AtsushiSakai/pythonrobotics)
[![Coverage Status](https://coveralls.io/repos/github/AtsushiSakai/PythonRobotics/badge.svg?branch=master)](https://coveralls.io/github/AtsushiSakai/PythonRobotics?branch=master)
[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/AtsushiSakai)

Python codes for robotics algorithm.
Expand Down

0 comments on commit 38d901c

Please sign in to comment.