Welcome to our contribution guide. This guide will help you understand the process and expectations for contributing.
If you want to report a bug, request a feature, or suggest an improvement, please open an issue on the GitHub repository and fill out the appropriate template.
If you find an existing issue that matches your problem, please:
- Add your reproduction details to the existing issue instead of creating a duplicate.
- Use reactions (e.g., 👍) on the issue to signal that it affects more users. GitHub reactions help maintainers prioritize issues based on user impact.
If no open issue addresses your problem, please open a new one and include:
- A clear title and detailed description of the issue.
- Relevant environment details (e.g., version, OS, configurations).
- A code sample or executable test case demonstrating the expected behavior that is not occurring.
To contribute to Suricate:
- Fork the repository to your own GitHub account
- Clone the project to your machine
- Create a branch from the
masterbranch - Make your changes and commit them to your branch
- Push your changes to your fork
- Open a merge request to the
masterbranch of the Suricate repository so that we can review your changes
We maintain a consistent code style using Spotless. For Java code, we follow the Palantir style.
To check for formatting issues, run:
mvn spotless:checkTo automatically fix formatting issues and add missing file headers, run:
mvn spotless:applyWe maintain a consistent code style using ESLint and Prettier.
We use Husky and Lint-Staged to perform linting and formatting checks before committing.
After the first npm install, everything should be set up automatically.