Contribution

Are you considering contributing to this project? That’s great; help is always welcome.

Tip

If you are not contributing a very obvious bug fix or documentation update, please start a discussion about your idea first. This will help to avoid wasted effort and ensure that your contribution is in line with the project’s goals.

0. Prerequisites

   • Understand and respect the goals of the project
   • Get familiar with the architecture
   • Accept the MIT license that will also apply to your contributions
   • Have Java 25 on your path

1. Fork the repository and clone it to your local machine

   See GitHub’s documentation for more information.

2. Create a feature branch from the develop branch

   The main branch is reserved for the current released version. Always base your work on the develop branch:

   git fetch origin
   git checkout -b feature/my-feature origin/develop

3. Write code and tests

   FastCSV enforces top-notch test coverage. Make sure to write proper tests for your code.

4. Build the project, run tests and static code analysis

   ./gradlew build

   To prevent performance degradation, run and compare benchmarks:

   ./gradlew jmh

5. Update documentation

   • Add your change to the CHANGELOG.md
   • Check documentation /docs/ for required updates or create new documentation
   • Update the README.md if necessary

6. Commit, push and create a pull request

   See GitHub’s documentation for more information.