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 Feb 8, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,15 +41,15 @@ You should usually open an issue in the following situations:
41
41
-**If you see an open issue that you want to tackle,** comment on the issue to let people know you're on it. That way, people are less likely to duplicate your work.
42
42
-**If an issue was opened a while ago,** it's possible that it's being addressed somewhere else, or has already been resolved, so comment to ask for confirmation before starting work.
43
43
-**If you opened an issue, but figured out the answer later on your own,** comment on the issue to let people know, then close the issue. Even documenting that outcome is a contribution to the project.
44
-
-**Please be patient** and _wait_ a response from maintainer or somebody else. Check out [_"What to do next?"_](https://github.com/tunnckoCore/contributing#what-can-i-do-while-im-waiting).
44
+
-**Please be patient** and _wait_for a response from the maintainer or somebody else. Check out [_"What to do next?"_](https://github.com/tunnckoCore/contributing#what-can-i-do-while-im-waiting).
45
45
46
46
### Include Any/All _Relevant_ Information in the _Issue Description_
47
47
48
-
- Please _include_ as much ***relevant information*** as you can like versions and operating system.
48
+
- Please _include_ as much ***relevant information*** as you can, such as versions and operating system.
49
49
- A _good_ issue _describes_ the idea in a _**concise** and **user-focused**_ way.
50
-
-***Never*** leave the issue _description_ blank even when you are in a "rush" - the point of issues is to _communicate_.
50
+
-***Never*** leave the issue _description_ blank even when you are in a "rush" - the point of an issue is to _communicate_.
51
51
52
-
**Why not empty description?** You _wouldn't_ send a _blank email_ to hundreds of your friends (_unless you wanted to freak them out!_), right? Submitting _blank issues_ is doing **exactly** that! It sends a ["_I have **no idea** what I'm doing_"](https://www.google.com/search?q=i+have+no+idea+what+i%27m+doing&tbm=isch)**message** to your _peers_.
52
+
**Why can't the description be empty?** You _wouldn't_ send a _blank email_ to hundreds of your friends (_unless you wanted to freak them out!_), right? Submitting _blank issues_ is doing **exactly** that! It sends a ["_I have **no idea** what I'm doing_"](https://www.google.com/search?q=i+have+no+idea+what+i%27m+doing&tbm=isch)**message** to your _peers_.
53
53
54
54
<!-- Part 3 -->
55
55
@@ -68,19 +68,19 @@ A pull request doesn't have to represent finished work. It's usually better to o
68
68
69
69
### Pro Tips to follow
70
70
71
-
-**Don't mind about the style** because we use [StandardJS](https://github.com/standard/standard), [ESLint](https://github.com/eslint/eslint) and [Prettier](https://github.com/prettier/prettier). Use `npm run lint` command.
72
-
-**Don't change the markdown files**, because the README is generated (it isn't hand written) and the API section is from JSDoc code comments. Let this step to us when _and if_ pull request is merged.
73
-
-**Dont't comment tests**, instead use `test.skip`. They'll still be shown in the output, but are never run.
71
+
-**Don't worry about the style** because we use [StandardJS](https://github.com/standard/standard), [ESLint](https://github.com/eslint/eslint) and [Prettier](https://github.com/prettier/prettier). Use the`npm run lint` command.
72
+
-**Don't change the markdown files**, because the README is generated (it isn't hand written) and the API section is from JSDoc code comments. Leave this step to us when,_and if_, the pull request is merged.
73
+
-**Don't comment out tests**, instead use `test.skip`. They'll still be shown in the output, but are never run.
74
74
75
75
### How to submit a pull request
76
76
77
77
There are just **8 easy steps** you should do. _**Please**_, follow them in _that exact_ order.
78
78
79
79
1.**[Fork the repository](https://guides.github.com/activities/forking/)** and clone it locally.
80
80
2.**[Create a branch](https://guides.github.com/introduction/flow/)** for your edits.
81
-
3.**Install dependencies** by running `npm install` command.
82
-
4.**Test everything is working** before you start _doing anything_ with `npm test` command. If something is wrong, please report it first and don't continue if you can't skip the problem easily.
83
-
5.**Reference any relevant issues** or supporting documentation or information in your PR (ex. "Closes #37.")
81
+
3.**Install dependencies** by running the `npm install` command.
82
+
4.**Test if everything is working** before you start _doing anything_ with the`npm test` command. If something is wrong, please report it first and don't continue if you can't skip the problem easily.
83
+
5.**Reference any relevant issues**, supporting documentation or information in your PR (ex. "Closes #37.")
84
84
6.**Test again or add new ones!** Run `npm test` again to _make sure_ your changes don't break existing tests.
85
85
7.**Commit your changes** by running `npm run commit`. It _will lead you_ through what the commit message _should look like_ and will run more tasks **to ensure** that code style and tests are okey.
86
86
8.**Wait response!** What to do in that time? Check out [_**"What to do next?"**_](https://github.com/tunnckoCore/contributing#what-can-i-do-while-im-waiting).
0 commit comments