Skip to content

Latest commit

 

History

History
81 lines (61 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

81 lines (61 loc) · 3.07 KB
Raw

Contribution Guidelines

We are looking forward to your contributions. Please take a moment to read these Contribution Guidelines.

Submitting Pull Requests

In case you want to submit a small fix, feel free to create a Pull Request. If you plan bigger changes, prefer to create an issue first to discuss the details. Make sure that your changes can be build and run on Linux, Mac and Windows. Your changes should also contain tests. Make sure that the coverage of new code is above 80%. Avoid breaking changes!

Some checks are unavailable for external Pull Requests from forks.

Maintainers have to run these checks manually.

Code Formatting

This project adhere to the Google Java Style Guide. You can use ./gradlew spotlessApply to format your code according to the style guide.

Changelog and Versioning

This project adheres to Semantic Versioning. Make sure that your commit messages follows the Semantic Commits conventions. Some examples for semantic commits:

  • feat(server-auth): add new key source - for new features inside the server-auth module, creates a new minor release.
  • fix(server-auth): make key source work on Palm devices - for fixes to existing features inside the server-auth module, creates a new patch release.
  • test(server-kafka): improve reliability for Kafka tests - for new or modified tests, no release is created.
  • docs: add a CONTRIBUTING.md - for changes that only modify documentation, no release is created.
  • chore: improve build speed - for changes to everything else, no release is created.

Our changelog is maintained in the GitHub releases.

PR Snapshots

PR Snapshots are unavailable for Pull Requests from forks!

Each PR creates a snapshot that can temporarily be included in other projects for testing. The generated version uses the format: PR-<pr_number>-SNAPSHOT. Snapshots are cleaned up regularly from the repository so never use snapshots in stable releases. The snapshots are currently hosted in our internal Nexus repository.

Import snapshots by adding the snapshot repository to the build.gradle:

    repositories {
      ...
      maven {
        url "https://nexus.sda-se.io/repository/sda-se-snapshots/"
        credentials {
          username sdaNexusUser
          password sdaNexusPassword
        }
      }
      ...
    }

Add to the dependencies (example):

    project.ext {
        sdaCommonsVersion = 'PR-1-SNAPSHOT'
    }

    dependencies {
      // define platform dependencies for simplified dependency management
      compile enforcedPlatform("org.sdase.commons.sda-commons-dependencies:$sdaCommonsVersion")
      compile enforcedPlatform("org.sdase.commons.sda-commons-bom:$sdaCommonsVersion")
      ...

      // Add dependencies to sda-commons-modules (managed by sda-commons-bom)
      compile "org.sdase.commons:sda-commons-client-jersey"
      ...
    }