mirror of
http://github.com/valkey-io/valkey
synced 2024-11-22 09:17:20 +00:00
0bfccc55e2
This PR adds a spell checker CI action that will fail future PRs if they introduce typos and spelling mistakes. This spell checker is based on blacklist of common spelling mistakes, so it will not catch everything, but at least it is also unlikely to cause false positives. Besides that, the PR also fixes many spelling mistakes and types, not all are a result of the spell checker we use. Here's a summary of other changes: 1. Scanned the entire source code and fixes all sorts of typos and spelling mistakes (including missing or extra spaces). 2. Outdated function / variable / argument names in comments 3. Fix outdated keyspace masks error log when we check `config.notify-keyspace-events` in loadServerConfigFromString. 4. Trim the white space at the end of line in `module.c`. Check: https://github.com/redis/redis/pull/7751 5. Some outdated https link URLs. 6. Fix some outdated comment. Such as: - In README: about the rdb, we used to said create a `thread`, change to `process` - dbRandomKey function coment (about the dictGetRandomKey, change to dictGetFairRandomKey) - notifyKeyspaceEvent fucntion comment (add type arg) - Some others minor fix in comment (Most of them are incorrectly quoted by variable names) 7. Modified the error log so that users can easily distinguish between TCP and TLS in `changeBindAddr`
57 lines
2.6 KiB
Plaintext
57 lines
2.6 KiB
Plaintext
Note: by contributing code to the Redis project in any form, including sending
|
|
a pull request via Github, a code fragment or patch via private email or
|
|
public discussion groups, you agree to release your code under the terms
|
|
of the BSD license that you can find in the COPYING file included in the Redis
|
|
source distribution. You will include BSD license in the COPYING file within
|
|
each source file that you contribute.
|
|
|
|
# IMPORTANT: HOW TO USE REDIS GITHUB ISSUES
|
|
|
|
Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature
|
|
requests. Everything else belongs to the Redis Google Group:
|
|
|
|
https://groups.google.com/forum/m/#!forum/Redis-db
|
|
|
|
PLEASE DO NOT POST GENERAL QUESTIONS that are not about bugs or suspected
|
|
bugs in the Github issues system. We'll be very happy to help you and provide
|
|
all the support in the mailing list.
|
|
|
|
There is also an active community of Redis users at Stack Overflow:
|
|
|
|
https://stackoverflow.com/questions/tagged/redis
|
|
|
|
Issues and pull requests for documentation belong on the redis-doc repo:
|
|
|
|
https://github.com/redis/redis-doc
|
|
|
|
If you are reporting a security bug or vulnerability, see SECURITY.md.
|
|
|
|
# How to provide a patch for a new feature
|
|
|
|
1. If it is a major feature or a semantical change, please don't start coding
|
|
straight away: if your feature is not a conceptual fit you'll lose a lot of
|
|
time writing the code without any reason. Start by posting in the mailing list
|
|
and creating an issue at Github with the description of, exactly, what you want
|
|
to accomplish and why. Use cases are important for features to be accepted.
|
|
Here you'll see if there is consensus about your idea.
|
|
|
|
2. If in step 1 you get an acknowledgment from the project leaders, use the
|
|
following procedure to submit a patch:
|
|
|
|
a. Fork Redis on github ( https://docs.github.com/en/github/getting-started-with-github/fork-a-repo )
|
|
b. Create a topic branch (git checkout -b my_branch)
|
|
c. Push to your branch (git push origin my_branch)
|
|
d. Initiate a pull request on github ( https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request )
|
|
e. Done :)
|
|
|
|
3. Keep in mind that we are very overloaded, so issues and PRs sometimes wait
|
|
for a *very* long time. However this is not lack of interest, as the project
|
|
gets more and more users, we find ourselves in a constant need to prioritize
|
|
certain issues/PRs over others. If you think your issue/PR is very important
|
|
try to popularize it, have other users commenting and sharing their point of
|
|
view and so forth. This helps.
|
|
|
|
4. For minor fixes just open a pull request on Github.
|
|
|
|
Thanks!
|