You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-04 15:02:09 +03:00
docs
This commit is contained in:
Salakar
39
.github/ISSUE_TEMPLATE.md
vendored
39
.github/ISSUE_TEMPLATE.md
vendored
@@ -1,15 +1,34 @@
|
||||
_Thanks for wanting to report an issue you've found in node_redis. Please delete
|
||||
---
|
||||
title: ⚠️ Bug report
|
||||
labels: needs-triage
|
||||
---
|
||||
|
||||
### Issue
|
||||
|
||||
<!--
|
||||
Thanks for wanting to report an issue you've found in node_redis. Please delete
|
||||
this text and fill in the template below. Please note that the issue tracker is only
|
||||
for bug reports or feature requests. If you have a question, please ask that on [gitter].
|
||||
If unsure about something, just do as best as you're able._
|
||||
for bug reports or feature requests.
|
||||
|
||||
_Note that it will be much easier to fix the issue if a test case that reproduces
|
||||
If you have a question, please ask it on Stack Overflow using the `node-redis` tag.
|
||||
|
||||
Note that it will be much easier to fix the issue if a test case that reproduces
|
||||
the problem is provided. It is of course not always possible to reduce your code
|
||||
to a small test case, but it's highly appreciated to have as much data as possible.
|
||||
Thank you!_
|
||||
with a small test case, but it's highly appreciated to have as much data as possible.
|
||||
-->
|
||||
|
||||
* **Version**: What node_redis and what redis version is the issue happening on?
|
||||
* **Platform**: What platform / version? (For example Node.js 0.10 or Node.js 5.7.0 on Windows 7 / Ubuntu 15.10 / Azure)
|
||||
* **Description**: Description of your issue, stack traces from errors and code that reproduces the issue
|
||||
> Describe your issue here
|
||||
|
||||
[gitter]: https://gitter.im/NodeRedis/node_redis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
|
||||
|
||||
---
|
||||
|
||||
### Environment
|
||||
|
||||
<!-- e.g. "node --version" -->
|
||||
- **Node.js Version**: `VERSION_HERE`
|
||||
|
||||
<!-- e.g. "redis-server --version" -->
|
||||
- **Redis Version**: `VERSION_HERE`
|
||||
|
||||
<!-- e.g. Windows 10, Mac OSX 10.15.2 -->
|
||||
- **Platform**: `PLATFORM_HERE`
|
||||
|
||||
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,14 +1,18 @@
|
||||
### Pull Request check-list
|
||||
### Description
|
||||
|
||||
_Please make sure to review and check all of these items:_
|
||||
<!-- Please provide a description of the change below, e.g What was the purpose? -->
|
||||
<!-- Why does it matter to you? What problem are you trying to solve? -->
|
||||
<!-- Tag in any linked issues. -->
|
||||
|
||||
|
||||
|
||||
### Check List
|
||||
|
||||
<!-- Please make sure to review and check all of these items: -->
|
||||
|
||||
- [ ] Does `npm test` pass with this change (including linting)?
|
||||
- [ ] Is the new or changed code fully tested?
|
||||
- [ ] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
|
||||
|
||||
_NOTE: these things are not required to open a PR and can be done
|
||||
afterwards / while the PR is open._
|
||||
|
||||
### Description of change
|
||||
|
||||
_Please provide a description of the change here._
|
||||
<!-- NOTE: these things are not required to open a PR and can be done
|
||||
afterwards / while the PR is open. -->
|
||||
|
||||
107
CONTRIBUTING.md
107
CONTRIBUTING.md
@@ -1 +1,106 @@
|
||||
<!-- TODO -->
|
||||
# Introduction
|
||||
|
||||
First, thank you for considering contributing to Node Redis! It's people like you that make the open source community such a great community! 😊
|
||||
|
||||
We welcome any type of contribution, not just code. You can help with;
|
||||
|
||||
- **QA**: file bug reports, the more details you can give the better (e.g. platform versions, screenshots sdk versions & logs)
|
||||
- **Docs**: improve reference coverage, add more examples, fix typos or anything else you can spot. At the top of every page on our docs site you can click the `Edit` pencil to go to that pages markdown file, or view the [Docs Repo](https://github.com/invertase/react-native-firebase-docs) directly
|
||||
- **Code**: take a look at the open issues. Even if you can't write code, commenting on them, showing that you care about a given issue matters.
|
||||
- **Donations**: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/node-redis).
|
||||
|
||||
---
|
||||
|
||||
## Project Guidelines
|
||||
|
||||
As maintainers of this project, we want to ensure that the project lives and continues to grow. Not blocked by any
|
||||
singular person's time.
|
||||
|
||||
One of the simplest ways of doing this is by encouraging a larger set of shallow contributors. Through this we hope to
|
||||
mitigate the problems of a project that needs updates but there is no-one who has the power to do so.
|
||||
|
||||
### Continuous Deployment
|
||||
|
||||
<!-- TODO(Salakar) -->
|
||||
Coming soon.
|
||||
|
||||
### How can we help you get comfortable contributing?
|
||||
|
||||
It is normal for a first pull request to be a potential fix for a problem but moving on from there to helping the
|
||||
project's direction can be difficult.
|
||||
|
||||
We try to help contributors cross that barrier by offering good first step issues (labelled `good-first-issue`). These
|
||||
issues can be fixed without feeling like you are stepping on toes. Generally, these should be non-critical issues that
|
||||
are well defined. They will be purposely avoided by mature contributors to the project, to make space for others.
|
||||
|
||||
Additionally issues labelled `needs-triage` or `help-wanted` can also be picked up, these may not necessarily require
|
||||
code changes but rather help with debugging and finding the cause of the issue whether it's a bug or a users incorrect
|
||||
setup of the library or project.
|
||||
|
||||
We aim to keep all project discussion inside GitHub issues. This is to make sure valuable discussion is accessible via
|
||||
search. If you have questions about how to use the library, or how the project is running - GitHub issues are the goto
|
||||
tool for this project.
|
||||
|
||||
### Our expectations on you as a contributor
|
||||
|
||||
You shouldn't feel bad for not contributing to open source. We want contributors like yourself to provide ideas, keep
|
||||
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
|
||||
enjoyable way. :trophy:
|
||||
|
||||
We only ask that you follow the conduct guidelines set out in our [Code of Conduct](/CODE_OF_CONDUCT.md) throughout your
|
||||
contribution journey.
|
||||
|
||||
### What about if you have problems that cannot be discussed in public?
|
||||
|
||||
You can reach out to us directly via email (`redis[AT]invertase.io`) or direct message us on
|
||||
[Twitter](https://twitter.com/NodeRedis) if you'd like to discuss something privately.
|
||||
|
||||
#### Project Maintainers
|
||||
|
||||
- Mike Diarmid ([Salakar](https://github.com/Salakar)) @ [Invertase](https://invertase.io)
|
||||
- Twitter: [@mikediarmid](https://twitter.com/mikediarmid)
|
||||
- Elliot Hesp ([Ehesp](https://github.com/Ehesp)) @ [Invertase](https://invertase.io)
|
||||
- Twitter: [@elliothesp](https://twitter.com/elliothesp)
|
||||
- Ruben Bridgewater ([BridgeAR](https://github.com/BridgeAR))
|
||||
- Twitter: [@BridgeAR](https://twitter.com/BridgeAR)
|
||||
|
||||
Huge thanks to the original author of Node Redis, [Matthew Ranney](https://github.com/mranney) and also to
|
||||
[Ruben Bridgewater](https://github.com/BridgeAR) for handing over this project over to new maintainers so it could be
|
||||
continuously maintained.
|
||||
|
||||
---
|
||||
|
||||
## Code Guidelines
|
||||
|
||||
### Your First Contribution
|
||||
|
||||
Working on your first Pull Request? You can learn how from this _free_ series,
|
||||
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
|
||||
|
||||
### Testing Code
|
||||
|
||||
Node Redis has a full test suite with coverage setup.
|
||||
|
||||
To run the tests use the `npm test` command. To check detailed coverage locally run the `npm run coverage` command after
|
||||
testing and open the generated `./coverage/index.html` in your browser.
|
||||
|
||||
### Submitting code for review
|
||||
|
||||
The bigger the pull request, the longer it will take to review and merge. Where possible try to break down large pull
|
||||
requests into smaller chunks that are easier to review and merge. It is also always helpful to have some context for
|
||||
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.
|
||||
|
||||
To aid review we also ask that you fill out the pull request template as much as possible.
|
||||
|
||||
> Use a `draft` pull request if your pull request is not complete or ready for review.
|
||||
|
||||
### Code review process
|
||||
|
||||
Pull Requests to the protected branches require two or more peer-review approvals and passing status checks to be able
|
||||
to be merged.
|
||||
|
||||
When reviewing a Pull Request please check the following steps on top of the existing automated checks:
|
||||
|
||||
- Does the it provide or update the docs if docs changes are required?
|
||||
- Have the tests been updated or new tests been added to test any newly implemented or changed functionality?
|
||||
- Is the testing coverage ok and not worse than previously?
|
||||
|
||||
Reference in New Issue
Block a user