Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit e56a457

Browse files
author
george
committed
update contrib
1 parent 1dfcc4f commit e56a457

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
All input is good input! Contributing to this project should be as easy and transparent as possible, whether it's:
44

5-
* Reporting a bug
6-
* Discussing the current state of the code
7-
* Submitting a fix
8-
* Proposing new features
9-
* Becoming a maintainer
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
1010

1111
## We Develop with Github
1212

@@ -18,11 +18,11 @@ All code changes happen through pull requests
1818

1919
Pull requests are the best way to propose changes to the codebase. Any kind of idea or change is welcome.
2020

21-
1. Fork the repo and create your branch from `develop`.
22-
2. If you've added code that should be tested, add tests.
23-
3. If you've changed APIs, update the documentation.
24-
4. If you've added dependencies, note what they are and why they are needed.
25-
5. Make sure your code and tests run without errors. It's also helpful if you've done a regression check against other areas of the framework, but not strictly required.
21+
1. Fork the repo and create your branch from `develop`.
22+
2. If you've added code that should be tested, add tests.
23+
3. If you've changed APIs, update the documentation.
24+
4. If you've added dependencies, note what they are and why they are needed.
25+
5. Make sure your code and tests run without errors. It's also helpful if you've done a regression check against other areas of the framework, but not strictly required.
2626

2727
## Any contributions you make will be under the MIT Software License
2828

@@ -40,11 +40,9 @@ The more detail, the less confusion!
4040

4141
## Use a Consistent Coding Style
4242

43-
Reference `.prettierrc` for code styling. Run `npm run lint` to apply styling to both css and javascript, or manually apply updates to files using `prettier`:
43+
If you're using a code editor, make sure it has plugins for prettier, eslint, and stylelint.
4444

45-
```sh
46-
$ prettier --write path/to/folder/**/*
47-
```
45+
If you don't have plugins for your editor, run `npm run prettify && npm run lint` to apply styling to both css and javascript before you commit changes.
4846

4947
## References
5048

0 commit comments

Comments
 (0)