Skip to content

Latest commit

 

History

History
104 lines (81 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

104 lines (81 loc) · 4.12 KB
Raw

How to contribute

You want to contribute?
First off, thanks for your interest in contributing to one of PILZ's open source projects. 👍

With this document we try to provide you with a set of guidelines to successfully contribute to our projects.
However, if you think that something is missing or if you think that something is incorrectly or badly explained, feel free to open a pull request to improve this document.

Reporting a Bug

Like many other projects on GitHub, we track bugs as GitHub issues. If you want to report a bug, please open an issue on the correct repository and use our issue template to provide all necessary information.
The following sections shortly describe the different information which should be included in the issue description.

Please note: The information requested, are important for us to understand and reproduce the issue and, consequently, to help you.

Software versions

At first, you should tell us the versions of all PILZ-ROS packages you are using. You can check the version of the installed PILZ-ROS packages with the following terminal commands:

dpkg -l ros-melodic-pilz*
dpkg -l ros-melodic-prbt*

Note:
If you are using kinetic, please substitute melodic with kinetic.

If you are building from source, tell us for each PILZ-ROS repository you are building, which version/commit you are using.

Steps to reproduce bug

The step by step description, enables us to easily reproduce the bug with our hardware which, in turn, is key in fixing the bug. Try to be as specific as possible. If it possible, try to reduce the scenario which produces the bug, to the absolute minimum. In other words, try to minimize the number of steps, needed to reproduce the bug.

Expected behavior

Tell us what you would expect to happen. This information allows us to verify, if it is an actual bug or maybe just a misunderstanding of some functionality. Furthermore, this information allow us, to ensure that the fixed system behaves as expected by the user.

Observed behavior

Tell us what is happening on your system in case of the bug. Sometimes, it is not so easy to understand what exactly the error is. The observed behavior allows, us to easier understand what went wrong and where you think the error lies.

Logfiles

To gain a complete picture of the system as a whole, we need a lot of information. You can provide us with the information needed, by copying the logging output from the terminal on which your ROS system runs into the issue description.

Please note: Do not forget to fence the logging output in the issue description with three backticks at the beginning and the end of the logging output, to ensure that the logging output format remains intact.

Reference to test

If possible you should provide us with a test, which allows us to reproduce the bug and check if the bug is fixed.

Adding new features/ fixing things

If you want to contribute to the code base you should:

  • create your own fork of the repository which you want to work on,
  • make your changes and then
  • open a pull request.

A good description on how-to contribute to a project can be found in the GitHub guides.
If you have only a rough idea of a new feature or if you are not sure about the best way to implement a feature, we encourage you to open a draft pull request as a basis for discussion.

When you want to open a pull request, you should first have a look at our development guidelines. The development guidelines give you an idea of all the things we consider important when developing new features or fixing bugs.
It is important to note that all pull requests undergo a rigorous review process. Please do not be disappointed if your pull request is not accepted right away. Often there exist a number of issues which need be fixed/changed before the pull request can be accepted.

To all people contributing/participating:
Thanks! ❤️ 💪

Your PILZ ROS Team