# Contributing to cooper-fastify

Thanks for considering a contribution. This document covers what you
need to know before opening an issue or a pull request.

## Getting started

```sh
git clone https://github.com/joetjen/node-cooper-fastify.git
cd node-cooper-fastify
npm install
npm test
```

That should complete with no failures on a clean checkout. If it
doesn't, please open an issue before doing anything else; that's a bug
in its own right.

## Project layout

- `src/cooper-fastify.{cjs,js}`: the plugin and the public API
  (`serverOptions`, `listenOptions`, `fileTag`, `version`).
- `src/load.cjs`: when the configuration is loaded, and with what --
  the rule every entry shares -- and registering `!file` on each load.
- `src/server-options.cjs`: the `fastify` block for `Fastify()` and
  `listen()`, `!module` values resolved.
- `src/file-tag.cjs`: the `!file` tag and the project root.
- `src/register.{cjs,js}`: the `@joetjen/cooper-fastify/register` preload entry.
- `types/cooper-fastify.d.ts`: the TypeScript declarations;
  `test/types/usage.ts` is compiled against them.
- `test/`: one spec per concern, plus `test/support/project.js` for
  throwaway projects.

## Making a change

1. **Tests first.** Write a failing test whose name reads as a sentence,
   then make it pass.
2. **Keep the boundary.** Loading, converting and reading belong to
   `cooper-config`; if a change needs one of them to behave
   differently, it goes there.
3. **Run the full verification pass before opening a PR:**

   ```sh
   npm run precommit
   npm run docs
   ```

## Commits and branches

This project uses [git flow](https://nvie.com/posts/a-successful-git-branching-model/)
(`feature/*` branches off `develop`) and
[Conventional Commits](https://www.conventionalcommits.org/). Add a line
under `[Unreleased]` in `CHANGELOG.md` for any user-facing change.

## Reporting bugs

Please include the smallest CASC document and Fastify setup that
reproduce the problem, the options you passed, what you expected, and
what happened. If the problem is in how the document itself loads, it
probably belongs to `node-cooper` or `node-cooper-config`.