Reword some documents #4589
Closed
Reword some documents #4589
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
youal
force-pushed
the
rewords_some_documents
branch
from
0027bd5 to
84f0ab6
Compare
cyphar
reviewed
Jan 13, 2025
PRINCIPLES.md
Outdated
| @@ -15,5 +15,5 @@ In the design and development of runc and libcontainer we try to follow these pr | |||
| * The fewer moving parts in a container, the better. | |||
| * Don't merge it unless you document it. | |||
| * Don't document it unless you can keep it up-to-date. | |||
| * Don't merge it unless you test it! | |||
| * Don't keep it up-to-date unless you test it! | |||
There was a problem hiding this comment.
The old version was correct, this one doesn't make sense.
|
Honestly I think we should delete some of these documents, as they were barely relevant in 2015 when they were first written and are even less relevant now... |
OK, then maybe it's just better to ignore this PR then. |
The git repository is the single source of truth for the project but I can not find any mention of any IRC channels anywhere. I assume that the channel does not exist. Signed-off-by: youal <y.oualmakran@gmail.com>
The project being written in go, having mentions of classes feels awkward. Signed-off-by: youal <y.oualmakran@gmail.com>
Having "merge it" in the last sentence of the sequence: * Don't merge it unless you document it. * Don't document it unless you can keep it up-to-date. * Don't merge it unless you test it! Makes the reading slighly uncomfortable by breaking the rythm. It would sound nicer if the pattern in keps between the sentences. Signed-off-by: youal <y.oualmakran@gmail.com>
This reverts commit 84f0ab6. Signed-off-by: youal <y.oualmakran@gmail.com>
youal
force-pushed
the
rewords_some_documents
branch
from
7d0b4b8 to
b5926d1
Compare
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.
Some documents have sentences that sound a little bit awkward.
This PR offers some suggestions concerning them.