You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-27
Original file line number
Diff line number
Diff line change
@@ -4,35 +4,21 @@ Thanks for contributing!
4
4
5
5
### Installing dependencies
6
6
7
+
We use [`yarn`](https://yarnpkg.com/en/docs/getting-started).
8
+
9
+
Install all dependencies by running
10
+
7
11
```sh
8
-
yarn install
12
+
yarn
9
13
```
10
14
11
-
You will find all building blocks that make up Spectacle in the [`src`](src) folder.
12
-
13
15
### Testing
14
16
15
-
You will find tests for files colocated with `*.test.js` suffixes. Whenever making any changes, ensure that all existing tests pass by running `yarn run test`.
16
-
17
-
If you are adding a new feature or some extra functionality, you should also make sure to accompany those changes with appropriate tests.
17
+
@TODO
18
18
19
19
### Linting and Formatting
20
20
21
-
Before committing any changes, be sure to do `yarn run lint`; this will lint all relevant files using [ESLint](http://eslint.org/) and report on any changes that you need to make.
22
-
23
-
You will also want to ensure your code meets the prettier formatting guidelines by running `yarn run prettier -l <filename>` on a specific file. If there are differences the script errors out. You can also specify a glob `yarn run prettier -l "src/**/*.js"` which will return a list of files that do not conform.
24
-
25
-
Alternatively, install the Prettier [editor plugin](https://prettier.io/docs/en/editors.html) in your favorite editor. This is the preferred method.
26
-
27
-
There is also a pre-commit hook in place to lint all staged files. If any of the staged files do not conform to the eslint rules or the [prettier](https://prettier.io/) formatting guidelines, your commit will fail until you resolve all outstanding issues.
28
-
29
-
To resolve/fix prettier formatting problems from the CLI:
30
-
31
-
```sh
32
-
yarn prettier-fix && yarn lint-fix
33
-
```
34
-
35
-
This will modify your file in place. You will need to `git add` the file again and re-commit.
21
+
@TODO
36
22
37
23
### Before submitting a PR...
38
24
@@ -43,12 +29,6 @@ Thanks for taking the time to help us make Spectacle even better! Before you go
43
29
- Update the [type definitions](./index.d.ts) for anything that modifies the Spectacle API, like breaking changes or new features.
44
30
- Everything else included in our [pull request checklist](https://github.com/FormidableLabs/spectacle/blob/master/.github/PULL_REQUEST_TEMPLATE.md#checklist-feel-free-to-delete-this-section-upon-completion)
45
31
46
-
## Releasing a new version to NPM (only for project administrators)
47
-
48
-
1. Run `npm version patch` (or `minor`, `major` as appropriate) to run tests and lint, build the `lib` and `dist` directories, and automatically update the `package.json` with a new git tag.
49
-
2. Run `npm publish` and publish to npm if all is well.
0 commit comments