Skip to content

Latest commit

 

History

History
39 lines (32 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

39 lines (32 loc) · 1.79 KB

Contributing

Best practices · Pull request process

First of all, thanks for taking the time to contribute!

This file includes best practices and guidelines for contributing to our project. We encourage you to follow them and help us create a better product!

Best practices

  • We follow a code of conduct, review it and honor it in all your interactions with the project.
  • When contributing to this repository, first create an issue to explain the change you want to make.
    • The issues will be preferably written in English, although Spanish is also acceptable.
    • The issue title should briefly summarize the proposal.
    • The issue body should include a description of the proposal with all the details, conditions, dependencies affected, charts, screenshots, etc., that can help to further understand and evaluate the proposal.
  • Create a new branch before making any change in the repository. This branch should follow this format: issue_ID-and-summary (for example, 23-add-new-provider).
  • Create commit messages following conventional commit specification.

Pull request process

  1. Ensure any install or build dependencies are solved before doing a build.
  2. Update the README.md file with details of the changes. This includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Set a commit message following Conventional Commits.
  4. If your Pull Request updates the documentation, label it as documentation.
  5. You may squash and merge the pull request once you have the sign-off of one maintainer. Maintainers will merge the pull request for you.