Skip to content

Commit

Permalink
Add changelog,contributing and license file
Browse files Browse the repository at this point in the history
  • Loading branch information
nWidart committed Jan 1, 2015
1 parent 70d73c7 commit ada8ef7
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Change Log
All notable changes to this project will be documented in this file.


## [0.1.0]() - 2015-01-01

First tagged version

### Added
- CHANGELOG.md file
- CONTRIBUTING.md file
- LICENSE.md file
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# How to contribute

Contributing to AsgardCMS is fairly straitforward. The easiest way is listed below.

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.

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.

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.


## Getting setup
### Modules

- Have an installation of [AsgardCMS/Platform](https://github.com/AsgardCms/Platform)
- Remove `.git/` directory
- Remove all modules from `composer.json` file
- `cd` into the `Modules/` folder and clone each Module individually
- Install AsgardCMS as usual `php artisan asgard:install`

### Themes

This is the same as modules except `cd`-ing into the `Themes/` folder and cloning desired themes in there.



## Making changes

Once you have your copy of AsgardCMS installed and configured for contributing purposes, you're ready to make changes.

AsgardCMS follows a workflow similar to **[Git Flow branching model](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow/)**.

This means:

- For a new feature:
- Create a branch `feature/your-new-feature-name`
- Add you changes
- Make sure the test suite for the module still passes
- [Squash commits](https://ariejan.net/2011/07/05/git-squash-your-latests-commits-into-one/) if necessary to create a nice history
- Send a pull request to the `develop` branch of the module/theme your modifying
- For a hotfix:
- Create a branch `hotfix/your-hotfix-name`
- Add a failing test that reproduces the found bug
- Add you changes by making the test pass
- [Squash commits](https://ariejan.net/2011/07/05/git-squash-your-latests-commits-into-one/) if necessary to create a nice history
- Send a pull request to the `develop` branch of the module/theme your modifying


# Additional Resources

* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
* `#asgardcms`IRC channel on freenode.org

10 changes: 10 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# License (MIT)


Copyright (c) 2013 Nicolas Widart , [email protected]

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.
13 changes: 13 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,16 @@
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/f6ca068c-662b-4606-9bee-262abc858f02/mini.png)](https://insight.sensiolabs.com/projects/f6ca068c-662b-4606-9bee-262abc858f02)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/AsgardCms/Menu/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/AsgardCms/Menu/?branch=master)
[![Code Climate](https://codeclimate.com/github/AsgardCms/Menu/badges/gpa.svg)](https://codeclimate.com/github/AsgardCms/Menu)


## Resources

- [View the changelog](CHANGELOG.md)
- [Contribute to AsgardCMS](CONTRIBUTING.md)
- [License](LICENSE.md)
- [Documentation](http://asgardcms.com/docs/menu-module/managing-menus)


## Info

All AsgardCMS modules respect [Semantic Versioning](http://semver.org/).

0 comments on commit ada8ef7

Please sign in to comment.