Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (25 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

42 lines (25 loc) · 1.68 KB

Contributing to Enviro Plus Web

Thanks for your interest in contributing, any feature and improvement from the community to make this project better is always welcome.

🤝 How to contribute

Reporting issues

If you find any bugs, issues, or have suggestions, please create a new issue and provide detailed information about the problem or feature.

Code contributions

  1. Fork the repository on GitLab.
  2. Create a new branch from the main branch for your changes.
  3. Make your modifications and ensure that your code follows the coding standards.
  4. Compile and test your changes thoroughly.
  5. Submit a pull request to the main branch with a clear title and description.

🛠️ Getting started

Setup your environment

  • Choose your favorite IDE and check that the configuration matches the .editorconfig setup to respect the same coding styles.
    By default, this project is developed using VSCodium with the plugins Prettier and SonarQube.

  • Get Git if you don't have it in your computer and after installation clone the repository by typing:

    git clone https://gitlab.com/idotj/enviroplusweb.git

Testing

Ensure that your changes do not break existing functionality. If applicable, provide tests for new features or bug fixes.

🔍 Code review process

All contributions will go through a code review process. Be prepared to address feedback and make necessary changes to your code.

⚖️ License

By contributing to this project, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0.