CONTRIBUTE.asciidoc

Contribute

Table of Contents

• Development process
  • Develop a feature
  • Develop a hotfix
  • Create a release
  • Publishing of a release

Development process

The development process follows the very simplified GitFlow process:

Develop a feature

Note	The master-branch may also be named main.

1. create a new branch on master-branch named like your feature

2. apply all your changes to that branch

3. use conventional commits referencing your ticket id if there’s such a ticket

4. create a PR into the master-branch

5. finish the PR using a squash merge providing a conventional-commit comment

Develop a hotfix

Follow the same process as developing a feature.

Create a release

1. create a Git tag inside the master-branch pointing to the commit to be released

2. the name of the tag has to follow the semantic versioning pattern <major>.<minor>.<patch> (the tag’s name is directly used as the release version).

Publishing of a release

Note	To publish a release on behalf of Intershop Communications AG, your Sonatype profile must be enabled and approved by an Intershop Communications AG employee for the com.intershop and com.intershop.gradle namespaces.

1. After creating the release, navigate to Sonatype and log in with your credentials.

2. In the sidebar, locate the Build Promotion section and click on the Staging Repository link. You should see the proposed release in the staging repository.

3. Review the staged release for correctness and completeness.

   1. If the release passes verification, select the release entry and click the Close button.

   2. If there are issues with the release, click the Drop button to discard the release entry. Make the necessary corrections and start over with the process.

4. Once the release is successfully closed, select the release entry again and click the Release button.

5. The release process is now complete. Please note, it may take several minutes to a few hours for the release to be publicly available on Maven Central Repository.