Skip to content

Commit e7a0883

Browse files
authored
Contributing docs: add some first-time contributing hints (#1608)
Fixes #1600
1 parent 6a1431c commit e7a0883

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ To learn more about the fork and pull request process, see [Fork a repository](h
125125
When you have the repository cloned locally, set up your local environment:
126126

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

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

@@ -138,6 +139,10 @@ When you have the repository cloned locally, set up your local environment:
138139

139140
`git checkout -b <your branch name>`
140141

142+
> [!TIP]
143+
> If you editor supports it, turn on automatic code formatting with Prettier.
144+
> Read Prettier's [Editor Integration](https://prettier.io/docs/en/editors) documentation for more information.
145+
141146
### Create a new feature from scratch
142147

143148
To create a new feature from scratch:
@@ -262,6 +267,7 @@ To set the status of your new feature, you must associate your feature with one
262267
To generate your feature's dist file, once your feature is associated with one or more BCD keys:
263268

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

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

0 commit comments

Comments
 (0)