CONTRIBUTING.md

Hardware Robot Information Model (HRIM)

Contributing HRIM project

Summary

1. Fork https://github.com/AcutronicRobotics/HRIM
2. Change/add your code
3. Send a pull request to be validated using the CI: https://github.com/AcutronicRobotics/HRIM/blob/master/.docker/ci/docker-entrypoint.sh

Code style

Make sure that your code complies with the code style that we have defined in our docs: https://acutronicrobotics.com/docs/technology/hrim/model/qa

Submit a pull request

Use GitHub's pull request mechanism to request that your updates get included in the master branch.

Report a bug

This section guides you through submitting a bug report for HRIM. Following these guidelines helps maintainers and the community understand your report and reproduce the bug.

Before creating bug reports, please check the list of issues to make sure if someone already had the same bug as you. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Use the following link to submit a bug report: https://github.com/AcutronicRobotics/HRIM/issues/new/choose

Feature request

Enhancement suggestions are tracked as GitHub issues.

How to:

• Use a clear and descriptive title for the issue to identify the suggestion.
• Explain why this enhancement would be useful.