mirror of
https://github.com/php/php-src.git
synced 2026-03-24 00:02:20 +01:00
[skip-ci] Improve documentation for better clarity to readers (#7066)
While reading the docs in the repo, I found & made a few improvements to the documentation so it's clearer to its readers. These improvements are around: typos, general punctuations, and grammar.
This commit is contained in:
@@ -1,14 +1,14 @@
|
||||
# Mailinglist rules
|
||||
# Mailing list rules
|
||||
|
||||
This is the first file you should be reading before doing any posts on PHP
|
||||
mailinglists. Following these rules is considered imperative to the success of
|
||||
the PHP project. Therefore expect your contributions to be of much less positive
|
||||
mailing lists. Following these rules is considered imperative to the success of
|
||||
the PHP project. Therefore, expect your contributions to be of much less positive
|
||||
impact if you do not follow these rules. More importantly you can actually
|
||||
assume that not following these rules will hurt the PHP project.
|
||||
|
||||
PHP is developed through the efforts of a large number of people.
|
||||
Collaboration is a Good Thing(tm), and mailinglists lets us do this. Thus,
|
||||
following some basic rules with regards to mailinglist usage will:
|
||||
Collaboration is a Good Thing(tm), and mailing lists lets us do this. Thus,
|
||||
following some basic rules with regards to mailing list usage will:
|
||||
|
||||
a. Make everybody happier, especially those responsible for developing PHP
|
||||
itself.
|
||||
@@ -24,11 +24,11 @@ Having said that, here are the organizational rules:
|
||||
1. Respect other people working on the project.
|
||||
|
||||
2. Do not post when you are angry. Any post can wait a few hours. Review
|
||||
your post after a good breather or a good nights sleep.
|
||||
your post after a good breather, or a good nights sleep.
|
||||
|
||||
3. Make sure you pick the right mailinglist for your posting. Please review
|
||||
3. Make sure you pick the right mailing list for your posting. Please review
|
||||
the descriptions on the
|
||||
[mailinglist overview page](https://www.php.net/mailing-lists.php). When
|
||||
[mailing list overview page](https://www.php.net/mailing-lists.php). When
|
||||
in doubt ask a friend or someone you trust on IRC.
|
||||
|
||||
4. Make sure you know what you are talking about. PHP is a very large project
|
||||
@@ -37,8 +37,8 @@ Having said that, here are the organizational rules:
|
||||
research before posting to the entire developer community.
|
||||
|
||||
5. Patches have a much greater chance of acceptance than just asking the
|
||||
PHP developers to implement a feature for you. For one it makes the
|
||||
discussion more concrete and it shows that the poster put thought and time
|
||||
PHP developers to implement a feature for you. For one, it makes the
|
||||
discussion more concrete, and it shows that the poster put thought and time
|
||||
into the request.
|
||||
|
||||
6. If you are posting to an existing thread, make sure that you know what
|
||||
@@ -51,7 +51,7 @@ Having said that, here are the organizational rules:
|
||||
The next few rules are more some general hints:
|
||||
|
||||
1. If you notice that your posting ratio is much higher than that of other
|
||||
people, double check the above rules. Try to wait a bit longer before
|
||||
people, double-check the above rules. Try to wait a bit longer before
|
||||
sending your replies to give other people more time to digest your answers
|
||||
and more importantly give you the opportunity to make sure that you
|
||||
aggregate your current position into a single mail instead of multiple
|
||||
|
||||
Reference in New Issue
Block a user