How to contribute

Orion Services is an open-source project, and we welcome contributions from the community. If you are interested in contributing to the project, please follow the guidelines with some profiles that we have available.

Developer

Orion Service is composed of several microservices and user interfaces. The microservices are written in Java/Quarkus and the user interfaces implemented in Vue/Nuxt. The first step to contribute to the project is to choose the technology that you want to work with. After that, you can look the open issues in our dashboard and choose one to work on. If you have any questions, you can ask in the issue or in our Discord server.

After to identify the issue, you can contribute to the project by submitting pull requests to the repository. To do so, follow these steps:

1. Fork the repository.
2. Create a new branch from dev branch.
3. Make your changes. Note: all repositories has a Github Codespaces configuration for you to start coding quickly.
4. Push the branch to your fork.
5. Submit a pull request.
6. Wait for the review and comments.
7. After the review, the project lead will merge the changes for you.
8. Celebrate!

Tester

To work as a tester, you don’t need to have a lot of programming skills. You just need to test the features and report bugs. The tester is an essential role in the project because it helps us to identify bugs and improve the quality of the code. The tester can also help us to write test cases, improve the test coverage and the quality of the project. In both cases, the tester plays a crucial role in the project. So, if you want to contribute to the project as a tester, you are welcome, so please contact us in our Discord server to know more about this role and grant you access to the project.

To review a pull request

After to be granted access to the project, you can start to review the pull requests.

1. Choose a pull request to test or review in our dashboard. Please, look the column Linked pull requests.
2. Test/review the issue.
3. If you find a bug, report it in the issuer tracker of the respective repository. Note: mark the issue with the label bug.
4. Wait for the fix.
5. Celebrate!

To write test cases

A tester can also help us by writing test cases for the project. Basically, the Orion Projects uses Java and JavaScript for the backend and frontend, thus, there are several frameworks and libraries that you can use to write test cases. If you want to contribute with test cases and code coverage, please contact us in our Discord server to know more about this role.

Documentation

The documentation is an essential part of the project. It helps users to understand how to use the services and developers to contribute to the project. If you want to contribute to the documentation, follow these steps:

1. Read the documentation.
2. If you find a mistake or something that can be improved, report it in the issuer tracker of the respective repository. Note: mark the issue with the label documentation.
3. Wait for the fix.
4. Celebrate!

Project Manager

The project manager is responsible for organizing the project and ensuring that the project is on track. As a project manager, you can help us by organizing issues, pull requests, and releases. Please, contact us in our Discord server to know more about this role.