Contributing to ts-csv is fairly easy. This document shows you how to get the project, run all provided tests and generate a production-ready build.

It also covers provided tasks that help you develop with ts-csv.

To make sure that the following instructions work, please install the following dependencies on you machine:

• Node.js (comes with a bundles npm)
• Git

To get the source of ts-csv, clone the git repository via:

This will clone the complete source to your local machine. Navigate to the project folder and install all needed dependencies via npm:

This command installs everything which is required for building and testing the project.

npm test executes the unit tests.

npm run build executes the build.

npm run watch executes the build in watch mode.

npm run codeclimate executes the code quality checks

• Check out a new branch based on development and name it to what you intend to do:

  • Example:

    git checkout -b BRANCH_NAME origin/development

    If you get an error, you may need to fetch development first by using

    git remote update && git fetch

  • Use one branch per fix/feature

• Make your changes
  • Make sure to provide a spec for unit tests.
  • Run your tests with npm test.
  • Save integration time and run code quality checks locally with npm run codeclimate
  • When all tests pass, everything's fine.
• Commit your changes
  • Please provide a git message that explains what you've done following the conventional commits pattern.
  • nodejs-project-info uses generate-changelog, so please make sure your commits follow the conventional commit pattern.
  • Commit to the forked repository.
  • Sign your commit.
• Make a pull request
  • Make sure you send the PR to the development branch.
  • CI is watching you!