Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reword some documents #4589

Closed
wants to merge 4 commits into from
Closed

Reword some documents #4589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c29efb5
Remove mention to IRC
youal Jan 13, 2025
ccceebb
Remove the mention of classes in PRINCIPLES.md
youal Jan 13, 2025
fbf7c85
Changes the sequence of sentences in PRINCIPLES.md
youal Jan 13, 2025
b5926d1
Revert "Changes the sequence of sentences in PRINCIPLES.md"
youal Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MAINTAINERS_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ It is every maintainer's responsibility to:
* 1) Expose a clear roadmap for improving their component.
* 2) Deliver prompt feedback and decisions on pull requests.
* 3) Be available to anyone with questions, bug reports, criticism etc.
on their component. This includes IRC and GitHub issues and pull requests.
on their component. This includes GitHub issues and pull requests.
* 4) Make sure their component respects the philosophy, design and
roadmap of the project.

Expand Down
2 changes: 1 addition & 1 deletion PRINCIPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In the design and development of runc and libcontainer we try to follow these pr

* Don't try to replace every tool. Instead, be an ingredient to improve them.
* Less code is better.
* Fewer components are better. Do you really need to add one more class?
* Fewer components are better. Do you really need to add one more function?
* 50 lines of straightforward, readable code is better than 10 lines of magic that nobody can understand.
* Don't do later what you can do now. "//TODO: refactor" is not acceptable in new code.
* When hesitating between two options, choose the one that is easier to reverse.
Expand Down