Skip to content

Commit dcdf1c7

Browse files
authored
[Doc] Add description for CONTRIBUTING.md (#773)
1 parent 0ea4d8c commit dcdf1c7

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Use a prefixed PR title to indicate the type of changes. Please use one of the f
2222
- ``[CI/Build]`` for build or continuous integration improvements.
2323
- ``[Doc]`` for documentation fixes and improvements.
2424
- ``[Integration]`` for changes in the ``mooncake-integration``.
25-
- ``[P2PStore]`` for changes in the ``mooncake-tp2p-store``.
25+
- ``[P2PStore]`` for changes in the ``mooncake-p2p-store``.
26+
- ``[Store]`` for changes in the ``mooncake-store``.
2627
- ``[TransferEngine]`` for changes in the ``mooncake-transfer-engine``.
2728
- ``[Misc]`` for PRs that do not fit the above categories. Please use this
2829
sparingly.
@@ -35,9 +36,7 @@ For major architectural changes (>500 LOC excluding tests), we would expect a Gi
3536

3637
The PR needs to meet the following code quality standards:
3738

38-
- We adhere to `Google Python style guide
39-
<https://google.github.io/styleguide/pyguide.html>`_ and `Google C++ style guide
40-
<https://google.github.io/styleguide/cppguide.html>`_.
39+
- We adhere to [Google Python style guide](https://google.github.io/styleguide/pyguide.html) and [Google C++ style guide](https://google.github.io/styleguide/cppguide.html).
4140
- The code needs to be well-documented to ensure future contributors can easily understand the code.
4241
- Include sufficient tests to ensure the project stays correct and robust. This includes both unit tests and integration tests.
4342
- Please add documentation to ``doc/`` if the PR modifies the user-facing behaviors of Mooncake. It helps Mooncake users understand and utilize the new features or changes.

0 commit comments

Comments
 (0)