Skip to content

Commit 64c7a11

Browse files
authored
chore: contributors removed; added to docs (#2359)
1 parent a82b8ad commit 64c7a11

File tree

3 files changed

+9
-121
lines changed

3 files changed

+9
-121
lines changed

.github/README.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -311,24 +311,27 @@ module.exports = {
311311

312312
## Contributing
313313

314-
Check out the [contributing guidelines](.github/CONTRIBUTING.md) for quick start information, and head over to the [component documentation](components/README.md) for more.
314+
A very special thank you to all of our [contributors](<https://github.com/adobe/spectrum-css/graphs/contributors>) without whom this project would not be possible.
315+
316+
Want to join the team? Check out the [contributing guidelines](.github/CONTRIBUTING.md) for quick start information.
315317

316318
### Building
317319

318320
Run the following commands:
319321

320322
```shell
321323
yarn install
322-
yarn start
323324
```
324325

325-
Your `dist/` folder should now have a local copy of the Spectrum CSS docs and minimal CSS files, and your browser should be open with the project's preview site. Editing any of the `.css` or the `.stories.js` files in `components/*` will update the project documentation and live reload in your browser.
326+
**Important:** Requires at least Node 18.x.
326327

327-
**Important:** Ensure you have Node.js > 14 installed or the build system will not run. Node.js > 16.x is preferred.
328+
```shell
329+
yarn start
330+
```
328331

329-
This project is leveraging caching from [Nx](https://nx.dev/) to speed up the build process. If you are seeing unexpected results, you can clear the cache by running `yarn nx clean` or `yarn nx run-many --target clean --all`.
332+
This will spin up the local development environment ([Storybook](https://storybook.js.org/docs/web-components/get-started/introduction)). Editing any of the `.css` or the `.stories.js` files in `components/*` will live reload in your browser.
330333

331-
To spin up the local development environment ([Storybook](https://storybook.js.org/docs/web-components/get-started/introduction)) without first building the components, use: `SKIP_BUILD=true yarn start` as `yarn start` alone will start from a clean build.
334+
This project is leveraging caching from [Nx](https://nx.dev/) to speed up the build process. If you are seeing unexpected results, you can clear the cache by running `yarn cache:clean`.
332335

333336
### Tasks
334337

package.json

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@
44
"version": "0.0.0",
55
"license": "Apache-2.0",
66
"author": "Adobe",
7-
"contributors": [
8-
"Cassondra Roberts <[email protected]> (https://allons-y.llc)",
9-
"Garth Braithwaite <[email protected]> (https://garthdb.com)",
10-
"Larry Davis <[email protected]>",
11-
"Patrick Fulton <[email protected]>",
12-
"Steve Gill <[email protected]>"
13-
],
147
"homepage": "https://opensource.adobe.com/spectrum-css/",
158
"repository": {
169
"type": "git",

0 commit comments

Comments
 (0)