lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-06-06 12:46:02 +02:00
Code Activity

maintainers-guide.md: wrap to 80 characters

Browse source
This commit is contained in:
Waldir Pimenta 2018-01-09 09:54:19 +00:00
parent 0a9f6f02d4
commit 652590372d
1 changed files with 17 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
contributing-guides/maintainers-guide.md
View file

@ -12,26 +12,34 @@ for the behavior expected of tldr-pages maintainers:
plase **create pull requests for all of your changes**, plase **create pull requests for all of your changes**,
except the simplest ones (e.g. typo fixes). except the simplest ones (e.g. typo fixes).
This ensures that the entire process other contributors go through This ensures that the entire process other contributors go through
is exposed to maintainers, who can then identify and address bottlenecks or inconveniences. is exposed to maintainers,
who can then identify and address bottlenecks or inconveniences.
Similarly, **avoid merging your own PRs**. Similarly, **avoid merging your own PRs**.
- Ideally, **every new discussion should receive a response within 24 hours**. - Ideally, **every new discussion should receive a response within 24 hours**.
You can respond yourself or ask other members to provide their thoughts/opinions. You can respond yourself
or ask other members to provide their thoughts/opinions.
- When merging PRs, use the strategy that produces a **clean git history** in the repository: - When merging PRs, use the strategy that produces a **clean git history**:
Use squash if there's a single commit in the PR, or if the multiple commits are not independent changes. Use squash if there's a single commit in the PR,
If the PR author took the time to craft individual, informative commit messages for each commit, or if the multiple commits are not independent changes.
If the PR author took the time to craft individual,
informative commit messages for each commit,
use regular merge to honor that work and preserve the history of the changes. use regular merge to honor that work and preserve the history of the changes.
- **Know when and how to say no**. - **Know when and how to say no**.
Sometimes requests or contributions need to be declined, at least in their current form. Sometimes requests or contributions need to be declined,
at least in their current form.
The project has developed multiple guidelines over time to handle edge cases The project has developed multiple guidelines over time to handle edge cases
— get acquainted with them, and point them out when necessary. — get acquainted with them, and point them out when necessary.
Be polite, but firm: it saves everyone's time and patience to make expectations clear early. Be polite, but firm: it saves everyone's time and patience
to make expectations clear early.
- Always remember to **thank every contribution**, - Always remember to **thank every contribution**,
even when it can't be accepted (in fact, especially then). even when it can't be accepted (in fact, especially then).
Keep in mind that [every form of contribution](https://github.com/kentcdodds/all-contributors) Keep in mind that
[every form of contribution](https://github.com/kentcdodds/all-contributors)
(pull request, feature request, bug report, etc.) (pull request, feature request, bug report, etc.)
is a voluntary gift of time offered to the tldr project by someone who cares about it, is a voluntary gift of time offered to the tldr project
by someone who cares about it,
so make sure not to take it for granted. so make sure not to take it for granted.