Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<a href="https://mmg-ai.com/en/"><img src="https://jderobot.github.io/assets/images/logo.png" width="100 " align="right" /></a>

# Contributing to RoboticsAcademy
# Contributing to RoboticsApplicationManager

First off, thanks for your interest in contributing to RoboticsApplicationManager! All contributors are welcome, from commenting issues to reviewing or sending Pull Requests.

You are contributing to a project that is used in others such as [RoboticsAcademy](https://github.com/JdeRobot/RoboticsAcademy) or [BT Studio](https://github.com/JdeRobot/bt-studio), because of this you must record the videos of the issues and fixes in one of this projects if possible.

## How to contribute?

If you are new to GitHub, visit the [first-contributions instructions](https://github.com/firstcontributions/first-contributions/blob/master/README.md) to learn how to contribute on GitHub.
Expand All @@ -12,4 +14,33 @@ To find issues you can help with, go though the list of [good first issues](http

Once found or created an issue, let us know that you want to work on it by commenting in the issue.

Please, make sure to follow our [coding style guide](https://github.com/JdeRobot/RoboticsAcademy/blob/humble-devel/docs/coding_style_guide.md) while working.

**Important**: this is Robotics RoboticsApplicationManager and it works as a part of Robotics Academy with its own structure and codebase. If you are not able comprehend it, this may not be a good project to contribute to. Submitting changes (Pull Request) or issues without that or without reading the documentation will be considered as **spam**. An example of bad submissions are: disabling the database, frontend and backend to "simplify development for low-risk developers" in [PR 3411](https://github.com/JdeRobot/RoboticsAcademy/pull/3411), submitting a standalone python script that tries to fix an issue that is not there in [PR 3421](https://github.com/JdeRobot/RoboticsAcademy/pull/3421), or submitting a PR without any kind of testing done to the changes [PR 3496](https://github.com/JdeRobot/RoboticsAcademy/pull/3496).

## Opening a Pull Request

If you have fixed an issue and want to share your fix create a pull request. If your pull request does not follow the next points it will not be accepted:

- Fixes the issue related to the pull request
- Does not contain any additional code than the one related to the fix
- Has been tested and compiled with corresponding videos of the before and after. This videos must be recorded in either [RoboticsAcademy](https://github.com/JdeRobot/RoboticsAcademy) or [BT Studio](https://github.com/JdeRobot/bt-studio). **Not a link to another webpage, you must add the video with Github's add file feature.**
- If the changes are still in progress open a Draft instead of a Pull Request. All PR will be considered as ready to merge
- The changes submitted must be up to date with the latest version of the branch they are being submitted to

If it breaks one of the points above you will be requested to change it and if you do not it will be closed.

Also do **not** ping or request reviews from maintainers or members of JdeRobot. The corresponding maintainer will assign a proper reviewer and ping other members if needed.

Finally, make sure to follow our [coding style guide](https://github.com/JdeRobot/RoboticsAcademy/blob/humble-devel/docs/coding_style_guide.md) while working.

## Questions, suggestions or new ideas

Please don't open an issue to ask a question or suggestion. Use the [GitHub Discussions](https://github.com/JdeRobot/RoboticsApplicationManager/discussions) which are meant for that. New ideas and enhancements are also welcome as discussion posts.

## Issue reporting

Feel free to [create a new issue](https://github.com/JdeRobot/RoboticsApplicationManager/issues/new) if you have some issue to report. But first, make sure that the issue has not been reported yet.

Be sure to explain in details the context and the outcome that you are looking for. If reporting bugs, provide basic information like your OS version, RoboticsBackend version and the exercise launched.

The responses to the issues **must** be related to the topic and they must not contain any solutions, for that use a Pull Request.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Robotics Application Manager (RAM) Documentation

## How to contribute?

Take a look at the [contributing](CONTRIBUTING.md) guidelines.

## Table of Contents

1. [Project Overview](#project-overview)
Expand Down
Loading