Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

55 lines (34 loc) · 3.31 KB

Contributing to serranito-hub

First of all we want to make it clear that this is a project for the subject Evolución y Gestión de la Configuración. In addition, this project is based on the original uvlhub project from Diverso-lab. Link here: https://github.com/diverso-lab/uvlhub

Thank you for your interest in contributing to serranito-hub. We love receiving contributions and are excited that you want to be part of this project. However, we want to inform you that contributions will only be accepted starting in February 2024.

🗓️ When can you contribute?

Starting from February 2024, you will be able to submit Pull Requests. In the meantime, feel free to familiarize yourself with the project, read the documentation, test the software, report bugs or suggest new features, and participate in discussions.

How You Can Contribute

From the mentioned date, here are the ways you can contribute:

1. Report Bugs

If you find a bug in the project, please open an issue detailing the steps to reproduce it, the environment in which it occurred, and any other relevant details. Use specified template for that.

2. Suggest New Features

If you have an idea for a new feature or enhancement, please open an issue explaining what you would like to accomplish and how you believe it could benefit the project. Use specified template for that.

3. Contribute Code

To contribute code, please follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone the repository to your local machine.
  3. Create a branch for your work (git checkout -b your-branch-name). Follow our specified branch metodology.
  4. Make your changes and commit with clear and descriptive messages. Follow our specified commit methodolody.
  5. Push your changes to your remote repository.
  6. Open a Pull Request (PR) from your branch to the main branch of the project. Use specified template for that.

4. Improve Documentation

If you find areas for improvement in the documentation, documentation improvements are always welcome! You can make changes to .md files or any other part of the documentation, but please follow our methodolofy.

Contribution Guidelines

Please read our code of conduct. It is not that hard to accomplish a good working enviroment anyways.

To maintain a positive and productive development environment, please follow these guidelines:

  • Be respectful: Treat others with kindness and respect.
  • Discuss significant changes first: If you're going to make major or structural changes to the codebase, please discuss it first in an issue to ensure everyone agrees.
  • Follow good development practices: Make sure the code you submit follows the project's coding style. Use linters or other tools if needed.
  • Test your code: Ensure that all your code is properly tested before submitting it.

License

By contributing to this project, you agree that your code will be licensed under the same license as the main project. All rights to your contribution will be subject to the project's GPL-30 license.

Contact

If you have any questions or would like to discuss the project further, feel free to contact the maintainers via in our discord. (https://discord.gg/w3vSdwS4)

Thank you for your interest in contributing to serranito-hub!