Skip to content

Contribution Guidelines#

Thank you for considering contributing to piveau! These guidelines will help you understand how to contribute effectively to the project.

Since piveau consists of various components these guidelines are focused on the general contribution procedures.

Please ensure that your contributions are compatible with the relevant technologies used in each component.

Getting Started#

  1. Fork the Repository: Use GitLab to fork the piveau repository to your own account.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://gitlab.com/your-user/piveau-x.git

  3. Create a New Branch: Create a new branch for your work. Please use a descriptive name for your branch.

    git checkout -b my-new-feature

  4. Make Changes: Make your desired changes to the codebase. Ensure your changes adhere to the project's coding standards and guidelines.

  5. Commit Changes: Commit your changes with clear and descriptive commit messages.

    git add . git commit -m "Add new feature"

  6. Push Changes: Push your changes to your forked repository on GitLab.

    git push origin my-new-feature

  7. Submit Merge Request: Open a merge request against the main repository. Be sure to reference any relevant issues in your merge request description.

Merge Request Guidelines#

  • Use the Merge Request Template: Follow the merge request template provided in GitLab when creating your merge request. Fill in all sections of the template to ensure clarity and completeness.

  • Code Review: Expect feedback and code review on your merge request. Address any requested changes promptly.

  • Continuous Integration (CI): Ensure that your changes pass all CI checks before submitting your merge request.

Licensing#

By contributing to Piveau, you agree to license your code under the terms of the Apache License 2.0. Please ensure that you accept these license terms for your contributions. This can be found in the merge request template.