Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 2.22 KB
Raw

Contributing to the virtual_racetracks_collection repository.

We love to collect virtual race tracks!
If you want to contribute to this project, please consider the following points:

We Develop with Github

We use GitHub to host code, to track issues, as well as accept pull requests.

All Race Track Contribuitions Happen Through Pull Requests

Pull requests are the best way to contribute a new virtual race track. We actively welcome your pull requests. Please perform the following steps:

  1. Fork the repo and create your branch from master.
  2. Whenever you want to contribute a new race track, please create a new branch with name 'race-track-' followed by 8 random alphanumeric characters. Always make a new branch, this is a good habit to get in, and will make your life easier.
  3. All race tracks contribuited should be located inside the launch folder.
  4. Your race track launch file should have the same name as the branch with extension .launch at the end.
  5. Ensure the race track displays correctly in Rviz.
  6. Make sure your commits do not delete submissions from others.
  7. Submit your pull request!
  8. Sometimes a PR in review might get a comment. Please be responsive to any questions and comments or otherwise you PR will not be merged.

Tip to write a great pull request:

  • Give it a clear name that sumarizes what the pull request is about.
  • Briefly describe the characteristics and design considerations of your race track.
  • Try to be specific in describing what is different.
  • Add a screenshot if you can.

Any contributions you make will be under the BSD 3-Clause

In short, when you submit code changes, your submissions are understood to be under the same BSD 3-Clause that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

License

By contributing, you agree that your contributions will be licensed under its BSD 3-Clause License.

References

This document was adapted from an contribuition guidelines example from briandk.