CONTRIBUTING.md

Contributing

By participating in this project, you agree to abide our Code of conduct.

Set up your machine

Prerequisites:

• Docker

Other things you might need to develop:

• IntelliJ IDEA (it's free for open-source development)

Clone the project anywhere:

git clone [email protected]:JetBrains/qodana-docker.git

cd into the directory, with Docker Bake you can build all images at once:

docker buildx bake

cd into .github/scripts and run the script to check product feed if you edited something in feed/releases.json:

cd .github/scripts && node verifyChecksums.js

Set up a new major release

To set up a directory for a new major release, run the script release_branch.sh with the release version as an argument. For example, to create a new directory for the 2025.1 release branch:

./release_branch.sh 2025.1

To generate Dockerfiles for that release (when you are ready to publish at least a new EAP):

./dockerfiles.py 2025.1

To add a newly released product, check 2025.1/public.json.

Create a commit

Commit messages should be well formatted, and to make that "standardized", we are using internal issue tracker references.

Submit a pull request

Push your branch to your repository fork and open a pull request against the main branch.

Create a new directory for a new release branch

Run the script release_branch.sh with the release version as an argument. For example, to create a new directory for the 2024.3 release branch:

./release_branch.sh 2024.3