-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(Contributions): Update contributions page to something more accu…
…rate / up-to-speed with latest project directions
- Loading branch information
1 parent
c4e9f0f
commit 7ec3bd8
Showing
1 changed file
with
13 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,17 @@ | ||
# CONTRIBUTIONS | ||
|
||
Send a pull request with your code and the tests for it. | ||
The library lives and prospers thanks to you. If you want to share some of your work, or if you have fixed some of the | ||
open issues, send a pull request with your code and the tests for it. | ||
|
||
Not mandatory at all but if you don't mind: | ||
We're currently re-organizing the project organization, and as such we're starting to adopt a stricter commit guideline, | ||
very much inspired from that of [AngularJS](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) | ||
|
||
* Prepend your commit message with `FIX:` or `NEW:`, make it easy to generate a readable CHANGELOG. | ||
So we ask you to respect 2 rules: | ||
1. Provide the code, the tests, all respecting the style guide | ||
2. Follow AngularJS commit style-guide that can, at the most minimum, be summarized by a single line like: | ||
`feat(solrCloud): Add ability to query pivot per field` | ||
|
||
Note: Please restrain from committing code that does other changes than what they are committed for. Avoid changing the | ||
style guide of entire files while committing fixes or features. | ||
|
||
*Thanks in advance for your support in making the library live.* |