Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

68 lines (49 loc) · 3.1 KB
Raw

Contributing to GymFC

👍🎉 Thank you for wanting to contribute to GymFC! 👍🎉

Together we can build next generation flight control systems 🚀 ✈️ 🚁 and there are many ways you can help!

Bug reporting

Please follow these steps when reporting a bug.

  1. Search through the issues to ensure your bug has not already been submitted.
  2. Open a new issue and describe at lengths how the bug can be reproduced.
  3. Include the full verbose output in markdown code block, not as an image. Images can't be searched.

Code Contributions

Please follow these steps in order to have your contribution considered by the maintainers.

  1. Search through the issues to verify your code changes have not already been discussed.

  2. Open an issue on Github outlining the changes you would like to make. Scope each issue to a single change (i.e., improvement to the documentation, a bug fix, a new feature, etc.). If there are multiple changes you'd like to propose, please open an new issue for each one. The issue serves as the location for discussing and documenting the change to be made. Once the change is approved continue to the next step.

  3. If you haven't already done so, fork the gymfc repository.

  4. Create a branch named i[issue number]-brief-description where [issue number] is the issue number previously created and brief-description is a brief description of the change you are making. For example i45-contribution.

  5. Make changes on your new branch, follow the style guide below. Test you code changes. Double check your commits to ensure unnecessary commits are not being made to keep the commit history clean.

  6. When you are happy with the code changes open up a pull request. Specify the issue the PR closes, for example Closes: #45. When the PR is merged, this keyword will automatically close the corresponding issue. Please provide testing results that will affect your code changes. A number of testing scripts already exist in /test that may help.

R&D

We are always in need of better models and reward functions.

Documentation and Examples

It can be intimidating getting into this research, it is very multi-disciplinary. Good documentation allows for more people to get involved.

Style Guides

Git messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Code

We adhere to Google's style guide for Python code. The Python guide can be found here.

To stay consistent with Gazebo, the Gazebo C++ plugins follow the Gazebo style guide found here.

Add your self as a contributor

GymFC uses the all-contributors bot to maintain a list of all contributors. When you open a PR be sure to add your self as a contributor using the bot usage here.