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
{{ message }}
This repository was archived by the owner on Oct 1, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
All input is good input! Contributing to this project should be as easy and transparent as possible, whether it's:
4
4
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
10
10
11
11
## We Develop with Github
12
12
@@ -18,11 +18,11 @@ All code changes happen through pull requests
18
18
19
19
Pull requests are the best way to propose changes to the codebase. Any kind of idea or change is welcome.
20
20
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.
26
26
27
27
## Any contributions you make will be under the MIT Software License
28
28
@@ -40,11 +40,9 @@ The more detail, the less confusion!
40
40
41
41
## Use a Consistent Coding Style
42
42
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.
44
44
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.
0 commit comments