Initial draft of contributing guide #1787
Open
Conversation
This file contains hidden or 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 <madelyneolson@gmail.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## unstable #1787 +/- ##
============================================
+ Coverage 71.09% 71.43% +0.33%
============================================
Files 123 122 -1
Lines 65552 66176 +624
============================================
+ Hits 46604 47272 +668
+ Misses 18948 18904 -44 🚀 New features to boost your workflow:
|
Signed-off-by: Madelyn Olson <madelyneolson@gmail.com>
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 <madelyneolson@gmail.com>
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. |
Member
There was a problem hiding this comment.
I believe we landed on 120'ish previously but I am personally more in favor of 90 .
Member
Author
There was a problem hiding this comment.
The original decision was prefer less than 90, but have a strong reason to have less than 120.
|
|
||
| 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. |
Member
There was a problem hiding this comment.
should we also outlaw the "_" prefix explicitly now? We can fix the existing ones gradually.
| 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. | ||
|
|
Member
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
Member
Author
There was a problem hiding this comment.
Yeah, I'll add a blurb here.
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 <madelyneolson@gmail.com>
xbasel
pushed a commit
to xbasel/valkey
that referenced
this pull request
Mar 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: valkey-io#1692. Included documentation about the licensing here: valkey-io#1787. Licenses are now also always explicitly first, even about documentation files. Signed-off-by: Madelyn Olson <madelyneolson@gmail.com>
xbasel
pushed a commit
to xbasel/valkey
that referenced
this pull request
Mar 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: valkey-io#1692. Included documentation about the licensing here: valkey-io#1787. Licenses are now also always explicitly first, even about documentation files. Signed-off-by: Madelyn Olson <madelyneolson@gmail.com>
zarkash-aws
pushed a commit
to zarkash-aws/valkey
that referenced
this pull request
Apr 6, 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: valkey-io#1692. Included documentation about the licensing here: valkey-io#1787. Licenses are now also always explicitly first, even about documentation files. Signed-off-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Shai Zarka <zarkash@amazon.com>
murphyjacob4
pushed a commit
to enjoy-binbin/valkey
that referenced
this pull request
Apr 13, 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: valkey-io#1692. Included documentation about the licensing here: valkey-io#1787. Licenses are now also always explicitly first, even about documentation files. Signed-off-by: Madelyn Olson <madelyneolson@gmail.com>
thaliaarchi
pushed a commit
to thaliaarchi/antirez-stringmatch
that referenced
this pull request
May 2, 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: valkey-io/valkey#1692. Included documentation about the licensing here: valkey-io/valkey#1787. Licenses are now also always explicitly first, even about documentation files. Signed-off-by: Madelyn Olson <madelyneolson@gmail.com> Source: valkey-io/valkey@089b830
Co-authored-by: Ping Xie <pingxie@outlook.com> Signed-off-by: Madelyn Olson <madelyneolson@gmail.com>
madolson
commented
May 28, 2025
Signed-off-by: Madelyn Olson <madelyneolson@gmail.com>
sarthakaggarwal97
approved these changes
May 29, 2025
Member
Author
|
@valkey-io/core-team Do we have further thoughts on this, I think it's mostly up to date. I want to add some more things, but would rather do those all incrementally. |
Co-authored-by: Viktor Söderqvist <viktor.soderqvist@est.tech> Signed-off-by: Madelyn Olson <madelyneolson@gmail.com>
enjoy-binbin
approved these changes
Dec 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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