Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ To learn more about the fork and pull request process, see [Fork a repository](h
When you have the repository cloned locally, set up your local environment:

1. [Install Node.js](https://nodejs.org).
See [`.nvmrc`](../.nvmrc) for the minimum required version.

1. At a command line prompt, navigate to the root of the repository:

Expand All @@ -113,6 +114,10 @@ When you have the repository cloned locally, set up your local environment:

`git checkout -b <your branch name>`

> [!TIP]
> If you editor supports it, turn on automatic code formatting with Prettier.
> Read Prettier's [Editor Integration](https://prettier.io/docs/en/editors) documentation for more information.

### Create a new feature from scratch

To create a new feature from scratch:
Expand Down Expand Up @@ -237,6 +242,7 @@ To set the status of your new feature, you must associate your feature with one
To generate your feature's dist file, once your feature is associated with one or more BCD keys:

1. Run the command `npm run dist`.
Optionally, run `npm run dist -- features/<feature-id>.yml` to regenerate only your feature's dist file.

1. Check that a new file, named after your feature ID, and with the `.yml.dist` file extension exists, and open the file.

Expand Down