CONTRIBUTING.md

Contributing to Remult

Contributions are welcome.

Before contributing please read the code of conduct and search the issue tracker to find out if your issue has already been discussed before.

To contribute, fork this repository, commit your changes, and send a pull request.

How to ?

A good way to start is installing everything and running tests.

npm i
npm run build
npm run test

Focus on a specific area ?

# Run only test for graphql for example
npm run test projects/tests/graphql.spec.ts

For servers tests

# in one terminal (to stay in watch mode for build and tests)
npm run build-watch

# in a second terminal (run only sveltekit tests in watch mode)
npm run test projects/tests/backend-tests/test-sveltekit-server.spec.ts

# in a third terminal (run only sveltekit build)
npm run test-servers:sveltekit:setup

You want to contribute to the documentation ?

The documentation is written in markdown and is located in the docs folder. You can run the documentation locally with the following command:

npm run docs

Note that each file starting with _ref are generated from the code itself and should not be edited manually. You can edit the jsdoc directly, and next generation will update docs.