Contributing to Jelly-JVM

Jelly-JVM is an open project – you are welcome to submit issues, pull requests, or just ask questions!

User & developer chat

If you have any questions or want to discuss a feature, you can join the Jelly Discord chat.

Code of conduct

By participating in this project, you are expected to follow our Code of conduct. Be kind, inclusive, and constructive.

Submitting issues

If you have a question, found a bug, or have an idea for a new feature, please open an issue in the GitHub issue tracker.

Security issues

If you find a security issue or vulnerability, please do not open a public issue. Instead, use the dedicated vulnerability reporting page.

Pull requests

Pull requests are welcome! Simply fork the GitHub repository and create a new branch for your changes. When you are ready, open a pull request to the main branch.

If you are working on a larger feature or a significant change, it is recommended to open an issue first to discuss the idea.

Formatting your code

We use prettier and JHipster's prettier-plugin-java to format our Java code. You can run the formatter with the following command:

npm install
npm run format:fix

The pull requests are expected to be formatted before being submitted. For IntellIJ users, you can set up the formatter to run automatically on save. To do this:

Open Settings -> Languages & Frameworks -> JavaScript -> Prettier
- Select Manual Prettier configuration
- Select node_modules/prettier from project directory for Prettier Package
- Check Run on 'Reformat Code' action
- Check Run on save
- Replace Run for files glob pattern with **/*.{java}

Documentation

Jelly-JVM uses the exact same documentation system as the main Jelly documentation. Further information on editing the documentation can be found in the Contributing to the Jelly documentation guide.

Releases

See the dedicated page on making releases.