Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 3.6 KB

CONTRIBUTING.md

File metadata and controls

74 lines (53 loc) · 3.6 KB
Raw

Contributing to VSS Simulation 🚀

Para a versão em PT-BR 🇧🇷 desse documento, veja aqui.

First of all, thanks for your interest! We really appreciate the participation of the community! ✨

Here we describe a set of guidelines when contributing to the VSS simulation. These are not strict rules, so use your best judgment, and in case you have questions, contact us on comp@thunderatz.org.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How can I contribute?

Issues

Most contributions are made with GitHub Issues. They will be primarily used for

  1. Trackking bugs - bug
  2. Suggesting Enhancements - enhancement
  3. Improving documentation - documentation

For each of these, there is a specific label. We strongly recommend that every issue created has at least one of the three labels described above.

But before creating an issue, first check if there is already one with the same subject. You can search and filter by labels, for example, here we only see the issues that are active and have the bug label.

Reporting Bugs 🐛

  • Use a clear title
  • Specify the version of the package
  • Specify OS, VM (if applicable), packages installed, and other configurations that may be usefull
  • Describe the steps to reproduce the bug
  • Describe the observed and the expected behavior
  • Include screenshots, gifs, any type of reference that helps to explain the problem

Suggesting Enhancements ✨

  • Use a clear title
  • Describe the suggestion step-by-step
  • Describe the expected behavior after implementing this idea
  • Explain why this new feature or update can be usefull

Imporoving documentation 📝

  • Use a clear title
  • Specify the files that need to be documented
  • Explain your suggestion and why would it be better/clearer

Pull Requests

If you want to contribute with code to the project, search for an open issue and start developing. When you are ready, open a Pull Request and we will review it.

A few recomendations:

  • Describe exactly what you've done, always as clear as possible
  • Link the applicable issue in your Pull Request (if there is none, please, create a new one)
  • Make sure that you are following the Syleguide

Styleguide 💄

The code and structure must follow the the ROS Use Patterns and ROS Best Practices.

Python

Python code should follow the ROS Python and the PEP 8 style guides.

Git commit messages

  • Use the present tense ("Add feature" not "Added feature")

  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")

  • It is strongly recommended to start a commit message with a related emoji

    • 📝 :memo: for documentation
    • 🐛 :bug: for bug issues
    • 🚑 :ambulance: for critical fixes
    • 🎨 :art: for imporoving structure
    • ✨ :sparkles: for new features

    For more examples, see this reference.

Git workflow

The project workflow is based on Git Flow.

Documentation

The documentation is generated with Doxygen and should follow its documenting manual.