@@ -13,59 +13,60 @@ We welcome any type of contribution, not just code. You can help with;
13
13
14
14
## Project Guidelines
15
15
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
17
17
singular person's time.
18
18
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
20
20
mitigate the problems of a project that needs updates but there is no-one who has the power to do so.
21
21
22
22
### Continuous Deployment
23
23
24
24
<!-- TODO(Salakar) -->
25
+
25
26
Coming soon.
26
27
27
28
### How can we help you get comfortable contributing?
28
29
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
30
31
project's direction can be difficult.
31
32
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
34
35
are well defined. They will be purposely avoided by mature contributors to the project, to make space for others.
35
36
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
38
39
setup of the library or project.
39
40
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
42
43
tool for this project.
43
44
44
45
### Our expectations on you as a contributor
45
46
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
48
49
enjoyable way. :trophy :
49
50
50
51
We only ask that you follow the conduct guidelines set out in our [ Code of Conduct] ( /CODE_OF_CONDUCT.md ) throughout your
51
52
contribution journey.
52
53
53
54
### What about if you have problems that cannot be discussed in public?
54
55
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
56
57
[ Twitter] ( https://twitter.com/NodeRedis ) if you'd like to discuss something privately.
57
58
58
59
#### Project Maintainers
59
60
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
69
70
continuously maintained.
70
71
71
72
---
@@ -74,7 +75,7 @@ continuously maintained.
74
75
75
76
### Your First Contribution
76
77
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,
78
79
[ How to Contribute to an Open Source Project on GitHub] ( https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github ) .
79
80
80
81
### Testing Code
@@ -86,8 +87,8 @@ testing and open the generated `./coverage/index.html` in your browser.
86
87
87
88
### Submitting code for review
88
89
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
91
92
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.
92
93
93
94
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
96
97
97
98
### Code review process
98
99
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
100
101
to be merged.
101
102
102
103
When reviewing a Pull Request please check the following steps on top of the existing automated checks:
0 commit comments