Skip to content

Commit c00a161

Browse files
committed
Rewrite documentation
Add contributing file Fix license file
1 parent 25b29c9 commit c00a161

File tree

5 files changed

+302
-237
lines changed

5 files changed

+302
-237
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Contributing
2+
============
3+
4+
First of all, **thank you** for contributing, **you are awesome**!
5+
6+
Here are a few rules to follow in order to ease code reviews, and discussions before
7+
maintainers accept and merge your work.
8+
9+
You MUST follow the [PSR-1](http://www.php-fig.org/psr/1/) and
10+
[PSR-2](http://www.php-fig.org/psr/2/). If you don't know about any of them, you
11+
should really read the recommendations. Can't wait? Use the [PHP-CS-Fixer
12+
tool](http://cs.sensiolabs.org/).
13+
14+
You MUST run the test suite.
15+
16+
You MUST write (or update) unit tests.
17+
18+
You SHOULD write documentation.
19+
20+
Please, write [commit messages that make
21+
sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
22+
and [rebase your branch](http://git-scm.com/book/en/Git-Branching-Rebasing)
23+
before submitting your Pull Request.
24+
25+
One may ask you to [squash your
26+
commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)
27+
too. This is used to "clean" your Pull Request before merging it (we don't want
28+
commits such as `fix tests`, `fix 2`, `fix 3`, etc.).
29+
30+
Also, while creating your Pull Request on GitHub, you MUST write a description
31+
which gives the context and/or explains why you are creating it.
32+
33+
Thank you!

README.markdown renamed to README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,33 @@ That means you'll be able to generate URL with given parameters like you can do
99

1010
This is a port of the _symfony 1.x_ plugin: [chCmsExposeRoutingPlugin](https://github.com/themouette/chCmsExposeRoutingPlugin).
1111

12-
#### Documentation
12+
Documentation
13+
-------------
1314

14-
Please, find the README file in `Resources/doc/` to get more information about this bundle.
15+
For documentation, see:
1516

16-
[Read the documentation](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/blob/master/Resources/doc/README.markdown)
17+
Resources/doc/
1718

19+
[Read the
20+
documentation](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/blob/master/Resources/doc/index.md)
1821

19-
#### License
22+
Contributing
23+
------------
2024

21-
See `Resources/meta/LICENSE`.
25+
See
26+
[CONTRIBUTING](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/blob/master/CONTRIBUTING.md)
27+
file.
2228

23-
24-
#### Original Credits
29+
Original Credits
30+
----------------
2531

2632
* William DURAND as main author.
2733
* Julien MUETTON (Carpe Hora) for the inspiration.
2834

35+
License
36+
-------
37+
38+
This bundle is released under the MIT license. See the complete license in the
39+
bundle:
40+
41+
Resources/meta/LICENSE

Resources/doc/README.markdown

Lines changed: 0 additions & 229 deletions
This file was deleted.

0 commit comments

Comments
 (0)