Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.18 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other direct method with me. For those of you on the Spot Micro Slack, contact me there (Maurice Rahme). Please be sure to follow the code of conduct.

Examples of Contributions

  1. New platform support (e.g. Gazebo, MuJoCo).
  2. RL Agent addition (e.g. DDPG, PPO).
  3. Simulation improvement (e.g. motor response in Pybullet)
  4. Sensing capabilities in simulation (e.g. LIDAR, Camera)

If in doubt, please talk to me, and I'll let you know if your idea will be helpful to the project. Some things are better served as issues, such as:

Examples of Issues

  1. Bugs.
  2. Feature Requests.
  3. Clarifications.
  4. Platform support (e.g. something is not working in your specific environment).

Pull Request Process

  1. Fork this repository.
  2. Create a new branch titled your-username
  3. Once your changes are ready, please send me a link to your branch so that I can try it out (there will be unit tests in the future).
  4. If I approve your change, you may merge to spot and submit a PR.