Skip to content

Commit b55742f

Browse files
committed
Add changelog,contributing and license file
1 parent 7825362 commit b55742f

File tree

4 files changed

+89
-0
lines changed

4 files changed

+89
-0
lines changed

CHANGELOG.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Change Log
2+
All notable changes to this project will be documented in this file.
3+
4+
5+
## [0.1.0]() - 2015-01-01
6+
7+
First tagged version
8+
9+
### Added
10+
- CHANGELOG.md file
11+
- CONTRIBUTING.md file
12+
- LICENSE.md file

CONTRIBUTING.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# How to contribute
2+
3+
Contributing to AsgardCMS is fairly straitforward. The easiest way is listed below.
4+
5+
Please note AsgardCMS follows **[PSR-1](http://www.php-fig.org/psr/psr-1/)** and **[PSR-2](http://www.php-fig.org/psr/psr-2/)**. Please make sure your code follows those standards.
6+
7+
You can use a great tool : **[PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer)** to make sure everything is following the correct coding style.
8+
9+
Install it globally and run it against the `Modules/` directory using `php-cs-fixer fix Modules/ --verbose`. Or run it individually for one module only, whichever you prefer.
10+
11+
12+
## Getting setup
13+
### Modules
14+
15+
- Have an installation of [AsgardCMS/Platform](https://github.com/AsgardCms/Platform)
16+
- Remove `.git/` directory
17+
- Remove all modules from `composer.json` file
18+
- `cd` into the `Modules/` folder and clone each Module individually
19+
- Install AsgardCMS as usual `php artisan asgard:install`
20+
21+
### Themes
22+
23+
This is the same as modules except `cd`-ing into the `Themes/` folder and cloning desired themes in there.
24+
25+
26+
27+
## Making changes
28+
29+
Once you have your copy of AsgardCMS installed and configured for contributing purposes, you're ready to make changes.
30+
31+
AsgardCMS follows a workflow similar to **[Git Flow branching model](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow/)**.
32+
33+
This means:
34+
35+
- For a new feature:
36+
- Create a branch `feature/your-new-feature-name`
37+
- Add you changes
38+
- Make sure the test suite for the module still passes
39+
- [Squash commits](https://ariejan.net/2011/07/05/git-squash-your-latests-commits-into-one/) if necessary to create a nice history
40+
- Send a pull request to the `develop` branch of the module/theme your modifying
41+
- For a hotfix:
42+
- Create a branch `hotfix/your-hotfix-name`
43+
- Add a failing test that reproduces the found bug
44+
- Add you changes by making the test pass
45+
- [Squash commits](https://ariejan.net/2011/07/05/git-squash-your-latests-commits-into-one/) if necessary to create a nice history
46+
- Send a pull request to the `develop` branch of the module/theme your modifying
47+
48+
49+
# Additional Resources
50+
51+
* [General GitHub documentation](http://help.github.com/)
52+
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
53+
* `#asgardcms`IRC channel on freenode.org
54+

LICENSE.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# License (MIT)
2+
3+
4+
Copyright (c) 2013 Nicolas Widart , [email protected]
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
7+
8+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
9+
10+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

readme.md

+13
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,16 @@ Run the migrations:
2222
``` bash
2323
php artisan module:migrate Page
2424
```
25+
26+
27+
## Resources
28+
29+
- [View the changelog](CHANGELOG.md)
30+
- [Contribute to AsgardCMS](CONTRIBUTING.md)
31+
- [License](LICENSE.md)
32+
- [Documentation]()
33+
34+
35+
## Info
36+
37+
All AsgardCMS modules respect [Semantic Versioning](http://semver.org/).

0 commit comments

Comments
 (0)