Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.71 KB
Raw

Contributing

Thank you for your interest in contributing to jcloc! We appreciate your efforts to make this project better. Before you start, please take a moment to read and understand the following guidelines.

Getting Started

  1. Fork the repository and clone your fork locally.
  2. Ensure the local development prerequisites are met, as outlined in the README.
  3. Create a new branch for your contribution. The branch name should follow the format of: label/short-name. For more information on valid labels, see the full list.
  4. Test your changes thoroughly via the build system: mvn clean package. If new features are being added, they must be accompanied by tests.
  5. Push your changes to your fork: git push origin label/short-name.
  6. Open a pull request (PR) against the master branch of this repository.

Pull Request Process

Ensure your PR description explains the purpose of your changes and provides context. Be sure to reference related issues by using linking keywords. Ensure your PR includes only relevant changes. Large changes should be broken into smaller, manageable PRs. Be prepared to make adjustments based on feedback received both by the automated actions and reviewers.

Style Guide

We use an automated CheckStyle action to enforce the project code style. To get a rough idea of the style we employ, refer to the CheckStyle configuration.

License

By contributing to this project, you agree that your contributions will be licensed under the project license.