Contributing to the Ctrlplane Jenkins Plugin

Thank you for considering contributing to the Ctrlplane Jenkins Plugin!

We welcome pull requests! Please follow these steps:

Fork the Repository: Create your own fork of the ctrlplanedev/jenkins-plugin repository.
Create a Branch: Create a new branch in your fork for your changes (e.g., git checkout -b feature/my-new-feature or git checkout -b fix/bug-description).
Make Changes: Implement your fix or feature.
- Adhere to the existing code style. Run mvn spotless:apply to format your code, and mvn verify to check code style and run tests.
- Add unit tests for new functionality or bug fixes, if applicable.
Test: Build the plugin (mvn clean package) and test your changes in a local Jenkins instance if possible.
Commit: Commit your changes with clear and concise commit messages.
Push: Push your branch to your fork (git push origin feature/my-new-feature).
Open a Pull Request: Go to the original repository and open a pull request from your branch to the main branch of ctrlplanedev/jenkins-plugin.
- Provide a clear title and description for your pull request, explaining the changes and referencing any related issues (e.g., "Fixes #123").

Code Style

This project uses Spotless Maven Plugin to enforce code style. Please run mvn spotless:apply before committing to format your code automatically.

If you have questions about contributing, feel free to open an issue.

Thank you for your contributions!