Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 2.82 KB
Raw

Contributing to Hirschgarten

We're excited that you're interested in contributing to Hirschgarten!
This document outlines the process for contributing to this project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How to Contribute

  1. Follow Coding Standards:

    • write new files in Kotlin
    • if you add new Kotlin library use kt_jvm_library from @rules_kotlin//kotlin:jvm.bzl
    • if you add a new test (JUnit 5) please use kt_test from @//rules/kotlin:junit5.bzl, with 1-1 test file to test target mapping

  2. Use the Project Formatter: Before submitting your changes, run the project formatter

    bazel run //tools/format:format

  3. Write Tests: Add tests for your changes if applicable. Document them as needed.

  4. Run Tests: Ensure all tests pass locally.

  5. Commit Your Changes: Make well-formatted commit messages.

  6. Open a Pull Request: Submit a pull request from your fork to the main Hirschgarten repository.

Pull Request Process

  1. Update the README.md with details of changes if applicable.
  2. Your pull request will be reviewed by maintainers, who may request changes or provide feedback.
  3. Once you submit your pull request, our CI pipeline will automatically run on your code.
  4. If the CI pipeline reports any issues, you'll need to address them. This may involve fixing failed tests, addressing code style issues, or resolving other automated checks.
  5. Once all CI checks pass and the code has been approved by maintainers, your pull request will be merged.

Continuous Integration

Upon submitting a pull request, our CI pipeline will automatically run a series of checks on your code. These checks may include:

  • Running all tests
  • Checking code style and formatting
  • Static code analysis
  • Building the project

If any of these checks fail, you'll see details in the pull request.
You'll need to address these issues and push new commits to your branch.
The CI pipeline will automatically re-run on new commits.
If some test passes locally but fails on CI and you don't understand the reason - ask maintainers for help in the PR comments.

Reporting Bugs

We use YouTrack for bug tracking. Please report bugs at our YouTrack project.
Before creating a new issue, please check existing issues to avoid duplicates.

Suggesting Enhancements

We welcome suggestions for improvements and new features.
Please use our YouTrack project to submit your ideas, clearly labeling them as feature requests/suggestions.

Getting Help

If you need help with your contribution or have questions about the CI process, feel free to ask questions in comments to your PR.

Thank you for contributing to Hirschgarten!