Skip to content

Commit caa5ac7

Browse files
committed
docs & npm ignore
1 parent f458505 commit caa5ac7

File tree

3 files changed

+28
-26
lines changed

3 files changed

+28
-26
lines changed

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ CODE_OF_CONDUCT.md
1717
.travis.yml
1818
appveyor.yml
1919
package-lock.json
20+
.prettierrc

CONTRIBUTING.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,59 +13,60 @@ We welcome any type of contribution, not just code. You can help with;
1313

1414
## Project Guidelines
1515

16-
As maintainers of this project, we want to ensure that the project lives and continues to grow. Not blocked by any
16+
As maintainers of this project, we want to ensure that the project lives and continues to grow. Not blocked by any
1717
singular person's time.
1818

19-
One of the simplest ways of doing this is by encouraging a larger set of shallow contributors. Through this we hope to
19+
One of the simplest ways of doing this is by encouraging a larger set of shallow contributors. Through this we hope to
2020
mitigate the problems of a project that needs updates but there is no-one who has the power to do so.
2121

2222
### Continuous Deployment
2323

2424
<!-- TODO(Salakar) -->
25+
2526
Coming soon.
2627

2728
### How can we help you get comfortable contributing?
2829

29-
It is normal for a first pull request to be a potential fix for a problem but moving on from there to helping the
30+
It is normal for a first pull request to be a potential fix for a problem but moving on from there to helping the
3031
project's direction can be difficult.
3132

32-
We try to help contributors cross that barrier by offering good first step issues (labelled `good-first-issue`). These
33-
issues can be fixed without feeling like you are stepping on toes. Generally, these should be non-critical issues that
33+
We try to help contributors cross that barrier by offering good first step issues (labelled `good-first-issue`). These
34+
issues can be fixed without feeling like you are stepping on toes. Generally, these should be non-critical issues that
3435
are well defined. They will be purposely avoided by mature contributors to the project, to make space for others.
3536

36-
Additionally issues labelled `needs-triage` or `help-wanted` can also be picked up, these may not necessarily require
37-
code changes but rather help with debugging and finding the cause of the issue whether it's a bug or a users incorrect
37+
Additionally issues labelled `needs-triage` or `help-wanted` can also be picked up, these may not necessarily require
38+
code changes but rather help with debugging and finding the cause of the issue whether it's a bug or a users incorrect
3839
setup of the library or project.
3940

40-
We aim to keep all project discussion inside GitHub issues. This is to make sure valuable discussion is accessible via
41-
search. If you have questions about how to use the library, or how the project is running - GitHub issues are the goto
41+
We aim to keep all project discussion inside GitHub issues. This is to make sure valuable discussion is accessible via
42+
search. If you have questions about how to use the library, or how the project is running - GitHub issues are the goto
4243
tool for this project.
4344

4445
### Our expectations on you as a contributor
4546

46-
You shouldn't feel bad for not contributing to open source. We want contributors like yourself to provide ideas, keep
47-
the ship shipping and to take some of the load from others. It is non-obligatory; we’re here to get things done in an
47+
You shouldn't feel bad for not contributing to open source. We want contributors like yourself to provide ideas, keep
48+
the ship shipping and to take some of the load from others. It is non-obligatory; we’re here to get things done in an
4849
enjoyable way. :trophy:
4950

5051
We only ask that you follow the conduct guidelines set out in our [Code of Conduct](/CODE_OF_CONDUCT.md) throughout your
5152
contribution journey.
5253

5354
### What about if you have problems that cannot be discussed in public?
5455

55-
You can reach out to us directly via email (`redis[AT]invertase.io`) or direct message us on
56+
You can reach out to us directly via email (`redis[AT]invertase.io`) or direct message us on
5657
[Twitter](https://twitter.com/NodeRedis) if you'd like to discuss something privately.
5758

5859
#### Project Maintainers
5960

60-
- Mike Diarmid ([Salakar](https://github.com/Salakar)) @ [Invertase](https://github.com/invertase)
61-
- Twitter: [@mikediarmid](https://twitter.com/mikediarmid)
62-
- Elliot Hesp ([Ehesp](https://github.com/Ehesp)) @ [Invertase](https://github.com/invertase)
63-
- Twitter: [@elliothesp](https://twitter.com/elliothesp)
64-
- Ruben Bridgewater ([BridgeAR](https://github.com/BridgeAR))
65-
- Twitter: [@BridgeAR](https://twitter.com/BridgeAR)
66-
67-
Huge thanks to the original author of Node Redis, [Matthew Ranney](https://github.com/mranney) and also to
68-
[Ruben Bridgewater](https://github.com/BridgeAR) for handing over this project over to new maintainers so it could be
61+
- Mike Diarmid ([Salakar](https://github.com/Salakar)) @ [Invertase](https://github.com/invertase)
62+
- Twitter: [@mikediarmid](https://twitter.com/mikediarmid)
63+
- Elliot Hesp ([Ehesp](https://github.com/Ehesp)) @ [Invertase](https://github.com/invertase)
64+
- Twitter: [@elliothesp](https://twitter.com/elliothesp)
65+
- Ruben Bridgewater ([BridgeAR](https://github.com/BridgeAR))
66+
- Twitter: [@BridgeAR](https://twitter.com/BridgeAR)
67+
68+
Huge thanks to the original author of Node Redis, [Matthew Ranney](https://github.com/mranney) and also to
69+
[Ruben Bridgewater](https://github.com/BridgeAR) for handing over this project over to new maintainers so it could be
6970
continuously maintained.
7071

7172
---
@@ -74,7 +75,7 @@ continuously maintained.
7475

7576
### Your First Contribution
7677

77-
Working on your first Pull Request? You can learn how from this _free_ series,
78+
Working on your first Pull Request? You can learn how from this _free_ series,
7879
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
7980

8081
### Testing Code
@@ -86,8 +87,8 @@ testing and open the generated `./coverage/index.html` in your browser.
8687

8788
### Submitting code for review
8889

89-
The bigger the pull request, the longer it will take to review and merge. Where possible try to break down large pull
90-
requests into smaller chunks that are easier to review and merge. It is also always helpful to have some context for
90+
The bigger the pull request, the longer it will take to review and merge. Where possible try to break down large pull
91+
requests into smaller chunks that are easier to review and merge. It is also always helpful to have some context for
9192
your pull request. What was the purpose? Why does it matter to you? What problem are you trying to solve? Tag in any linked issues.
9293

9394
To aid review we also ask that you fill out the pull request template as much as possible.
@@ -96,7 +97,7 @@ To aid review we also ask that you fill out the pull request template as much as
9697
9798
### Code review process
9899

99-
Pull Requests to the protected branches require two or more peer-review approvals and passing status checks to be able
100+
Pull Requests to the protected branches require two or more peer-review approvals and passing status checks to be able
100101
to be merged.
101102

102103
When reviewing a Pull Request please check the following steps on top of the existing automated checks:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -971,7 +971,7 @@ Good stack traces are only activated in development and debug mode as this
971971
results in a significant performance penalty.
972972

973973
**_Comparison_**:
974-
974+
975975
Standard stack trace:
976976

977977
```

0 commit comments

Comments
 (0)