浏览代码

Improve contribution guidelines

pull/329/merge
Jamie 10 年前
父节点
当前提交
03d5f710bb
共有 1 个文件被更改,包括 13 次插入4 次删除
  1. 13
    4
      CONTRIBUTING.md

+ 13
- 4
CONTRIBUTING.md 查看文件

@@ -1,15 +1,24 @@
1 1
 # Contribution Guidelines
2
-Please ensure your pull request adheres to the following guidelines:
2
+Unfortunately, not every library, tool or framework can be considered. The aim of Awesome PHP is to be a concise list of noteworthy and interesting software written in modern PHP. Therefore, suggested software should: 
3 3
 
4
+a) Be widely recommend regardless of personal opinion
5
+b) Well known or discussed in the PHP community
6
+c) Be unique in its approach or function
7
+d) Fill a niche gap in the market
8
+
9
+Self-promotion is frowned upon, so please seriously consider whether your project meets the above criteria before making a suggestion, otherwise it may be closed without being reviewed.
10
+
11
+Also, please ensure your pull request adheres to the following guidelines:
12
+
13
+* Software that is PHP 5.5+, Composer-installable, PSR compliant, united tested and well documented are preferred.
4 14
 * Please search previous suggestions before making a new one, as yours may be a duplicate.
5
-* Libraries that are PHP 5.3+, Composer-installable, PSR compliant, tested and documented are preferred.
6 15
 * Enter a meaningful pull request description.
7 16
 * Please make an individual commit for each suggestion in a pull request.
8
-* Put a link to each library in your pull request ticket so they're easier to look at.
17
+* Put a link to each library in your pull request ticket so it's easier to review.
9 18
 * Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION.
10 19
 * Prefix duplicate library names with their vendor or namespace followed by a space: Foo\Bar would be Foo Bar.
11 20
 * New categories, or improvements to the existing categorisation, are always welcome.
12
-* Keep descriptions short and simple. 
21
+* Keep descriptions short, simple and unbiased. 
13 22
 * End all descriptions with a full stop/period.
14 23
 * Check your spelling and grammar.
15 24
 * Make sure your text editor is set to remove trailing whitespace.

正在加载...
取消
保存