Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (63 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

87 lines (63 loc) · 2.2 KB

Contributing to Jenkins Gradle Convention Plugin

Thank you for your interest in contributing! Your help makes this project better for everyone.

Getting Started

  1. Fork the repository and clone your fork.
  2. Create a new branch for your change: 
    git checkout -b my-feature
  3. Install prerequisites:
  4. Build and test locally: 
    ./gradlew build

Development Guidelines

  • Code style: Follow Kotlin and Java idioms. Use ./gradlew spotlessApply to auto-format.
  • Keep builds reproducible: Use exact dependency versions.
  • Document public APIs: KDoc for Kotlin, Javadoc for Java.
  • Add or update tests for new features or bugfixes.
  • Avoid breaking changes unless absolutely necessary. If so, clearly document them.

Running Tests

  • Run all tests before submitting: 
    ./gradlew test
  • For integration tests, see /src/integrationTest.

Making a Pull Request

  1. Sync your branch with main before submitting.
  2. Complete the PR template and describe your changes clearly.
  3. Reference related issues (e.g., Closes #123).
  4. Ensure CI passes—your PR must be green.
  5. Be responsive to feedback and requested changes.

Reporting Bugs

  • Use the Bug Report template.
  • Include:
    • Steps to reproduce
    • Actual and expected behavior
    • Environment info (Gradle, Java, OS, plugin versions)
    • Relevant logs or stack traces

Suggesting Features or Improvements

  • Open a new issue or discussion with:
    • Problem statement
    • Proposed solution/feature
    • Example use cases

Resources

Thank you for helping make this project awesome! 🚀