Initial draft of contributing guide #1787
Open
+54
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Madelyn Olson <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## unstable #1787 +/- ##
============================================
+ Coverage 71.09% 71.18% +0.09%
============================================
Files 123 123
Lines 65552 65641 +89
============================================
+ Hits 46604 46728 +124
+ Misses 18948 18913 -35 |
Signed-off-by: Madelyn Olson <[email protected]>
hwware
pushed a commit
that referenced
this pull request
Feb 27, 2025
Use a consistent set of licenses for Valkey files. I took a look and applied sort of a "did we make a material change in this file?" and tried to be conservative in adding the trademark. We could also be liberal as well. Resolves: #1692. Included documentation about the licensing here: #1787. Licenses are now also always explicitly first, even about documentation files. Signed-off-by: Madelyn Olson <[email protected]>
hwware
approved these changes
Feb 27, 2025
PingXie
reviewed
Feb 27, 2025
| Most of the style guidelines are enforced by clang format, but some additional comments are included here. | ||
|
|
||
| 1. C style comments `/* comment */` can be used for both single and multi-line comments. C++ comments `//` can only be used for single line comments. | ||
| 1. Generally keep line lengths below 90 characters, however there is no explicit line length enforcement. |
There was a problem hiding this comment.
I believe we landed on 120'ish previously but I am personally more in favor of 90 .
|
|
||
| 1. C style comments `/* comment */` can be used for both single and multi-line comments. C++ comments `//` can only be used for single line comments. | ||
| 1. Generally keep line lengths below 90 characters, however there is no explicit line length enforcement. | ||
| 1. Use static functions when a function is only intended to be accessed from the same file. |
There was a problem hiding this comment.
should we also outlaw the "_" prefix explicitly now? We can fix the existing ones gradually.
| ## Naming conventions | ||
| Valkey has a long history of inconsistent naming conventions. Generally follow the style of the surrounding code, but you can also always use the following conventions for variable and structure names: | ||
|
|
||
| - Variable names: `snake_case` or all lower case (e.g. `valkeyobject` or `valkey_object`) |
There was a problem hiding this comment.
can we converge on snake_case exclusively, for the new code?
| All contributions should include a test of some form. | ||
|
|
||
| Unit tests are present in the `src/unit` directory, and are intended to test individual structures or files. | ||
| For example, most changes to datastructures should include corresponding unit tests. |
There was a problem hiding this comment.
Suggested change
| For example, most changes to datastructures should include corresponding unit tests. | |
| For example, most changes to data structures should include corresponding unit tests. |
| Integration tests are located in the `tests/` directory, and are intended to test end-to-end functionality. | ||
| Adding new commands should come with corresponding integration tests. | ||
| When writing cluster mode tests, do not use the legacy `tests/cluster` framework, which has been deprecated. | ||
|
|
There was a problem hiding this comment.
can we add a documentation section as well? new commands, configs, non-trivial features should come with documentation? blogs are also encouraged for major features, such as the 1M QPS, the hash table rewrite
zuiderkwast
pushed a commit
that referenced
this pull request
Mar 18, 2025
Use a consistent set of licenses for Valkey files. I took a look and applied sort of a "did we make a material change in this file?" and tried to be conservative in adding the trademark. We could also be liberal as well. Resolves: #1692. Included documentation about the licensing here: #1787. Licenses are now also always explicitly first, even about documentation files. Signed-off-by: Madelyn Olson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Took the suggestions from the development guide issue and tried to write them up. The one thing still missing is the backporting, since it seems we aligned on creating a bot, but we don't have the bot yet.
Fixes: #1558