Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 1.13 KB

Development

Clone the repository:

git clone git@github.com:blomqma/next-rest-framework.git

Install dependencies:

pnpm i

Build the next-rest-framework package:

pnpm run build

Run the development Next.js project:

pnpm run dev

To test your changes in the next-rest-framework package against the dev project, simply rebuild the package with pnpm run build and the changes will be synced automatically.

Run unit tests:

pnpm run test

Run unit tests in watch mode:

pnpm run test:watch

Run formatting:

pnpm run format

Run linting:

pnpm run lint

Documentation

All documentation is in README.md, please update that when needed.

Pull requests

All pull requests are welcome and done against the main branch, please write tests for all changes, write documentation when needed and use descriptive commit messages. No need to update the changelog.

License

By contributing, you agree to license your contribution under the LICENSE.