diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b120ee1..93d1abe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,18 +15,18 @@ Please note we have a **code of conduct**, please follow it in all your interact - For chores/the rest: `chore/[descriptive_chore_name]` 4. Install dependencies with Yarn: `yarn install` -5. Add `./node_modules/.bin` to your system's [`PATH`](https://en.wikipedia.org/wiki/PATH_(variable)), if it's not already listed. +5. Add `./node_modules/.bin` to your system's [`PATH`](), if it's not already listed. 6. Start building for development: `yarn dev` ### Development Scripts -| NPM Script | Description | -| --------------------------- | ----------- | -| `yarn dev` | Start building the CLI tool in development mode. | -| `yarn build` | Build the CLI tool for production. | -| `yarn clean` | Run cleaning scripts. | -| `yarn lint` | Run the linter. | -| `yarn test` | Run unit tests. | +| NPM Script | Description | +| ------------ | ------------------------------------------------ | +| `yarn dev` | Start building the CLI tool in development mode. | +| `yarn build` | Build the CLI tool for production. | +| `yarn clean` | Run cleaning scripts. | +| `yarn lint` | Run the linter. | +| `yarn test` | Run unit tests. | ## Opening a Pull Request @@ -38,6 +38,73 @@ Please note we have a **code of conduct**, please follow it in all your interact We use [`auto`](https://github.com/intuit/auto) as our continous delivery tool. Cutting a release is just a matter of merging to `master`. For pre-releases, you can create a `next` branch as the base for your experimental/W.I.P. feature. Please familiarize yourself with the [documentation for `auto`](https://intuit.github.io/auto/docs) if you are in a position to cut a release. +## Community Templates + +### Adding a new template + +1. Fork the repository. +2. Create a new branch `feat/`. +3. Create a new directory under `scaffolds` named ``. +4. Under that, create a `