Skip to content

Commit 229ea92

Browse files
update CONTRIBUTING.md
1 parent ec79732 commit 229ea92

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,28 @@
3636
2. If you are **not** the author or maintainer of the lib, please tell us where are those files from, like the url of its download page, or the url of releases page of the library.
3737
* If you are the author or maintainer of the lib, please just add `[author]` in th pull request's title.
3838

39-
3. If it doesn't have officially minified files, please minify all of the main css/js files, and give them a file name as `library.min.js`.
39+
3. If you are adding a **new** lib into cdnjs, please add `[new]` in the pull request's title.
40+
41+
4. If it doesn't have officially minified files, please minify all of the main css/js files, and give them a file name as `library.min.js`.
4042
* cdnjs's preferred JavaScript minifier is [UglifyJS](http://marijnhaverbeke.nl/uglifyjs "UglifyJS")
4143
* You can also use [web-minify-helper](https://github.com/PeterDaveHello/web-minify-helper "web-minify-helper") to help you do this automatically, it supports both css and js.
4244

43-
4. Filenames should **not** include a version number and be **lowercase**.
45+
5. Filenames should **not** include a version number and be **lowercase**.
4446
* This is OK: `useful.min.js`, but this is not: `useful-2.0.1.min.js`.
4547

46-
5. Only do **one** thing or **strongly related** works in one commits, don't mix different things into the same commit.
48+
6. Only do **one** thing or **strongly related** works in one commits, don't mix different things into the same commit.
4749

48-
6. Every commit should be meaningful, don't cut one thing into multiple commits, unless you are trying to fix an existing problem in the master branch.
50+
7. Every commit should be meaningful, don't cut one thing into multiple commits, unless you are trying to fix an existing problem in the master branch.
4951
* Like adding a lib, but it has some problem, so come with many commits to fix, that will not be allowed.
5052

51-
7. Do **not** do things which are **not** related with your commit log.
53+
8. Do **not** do things which are **not** related with your commit log.
5254

53-
8. We **only** host the css/js libs with **production** version, unless the project is very popular, like jQuery, this is for maintainer to decide.
55+
9. We **only** host the css/js libs with **production** version, unless the project is very popular, like jQuery, this is for maintainer to decide.
5456
* If you have a good reason to host a alpha/beta/RC or other non-production version, please feel free to explain in comments.
5557

56-
9. If you are asked to modify the commits, please use `git commit --amend`/`git rebase` to update your commits, and use `--force` parameter with git push to update the pull request.
58+
10. If you are asked to modify the commits, please use `git commit --amend`/`git rebase` to update your commits, and use `--force` parameter with git push to update the pull request.
5759

58-
10. You **should** go back to the PR page after you sent the PR for 15~25 mins, and check if you passed the CI build, if not, please take a look at the error message and try to fix, we **won't** merge a PR with a failed build.
60+
11. You **should** go back to the PR page after you sent the PR for 15~25 mins, and check if you passed the CI build, if not, please take a look at the error message and try to fix, we **won't** merge a PR with a failed build.
5961
* Feel free to ask for help if you have no idea.
6062

6163
### b. Updating an existing library

0 commit comments

Comments
 (0)