diff --git a/.gitignore b/.gitignore index 0edca0f..45fc8a5 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,4 @@ /app/config/parameters.yml /app/logs/* !app/logs/.gitkeep -/app/phpunit.xml \ No newline at end of file +/phpunit.xml \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index 5d529d0..cda733e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,4 +4,12 @@ php: - '5.6' - '7.0' - hhvm - - nightly \ No newline at end of file + - nightly + +before_install: + - travis_retry composer self-update + +install: + - travis_retry composer install --no-interaction --prefer-dist + +script: phpunit diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7be9ba6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +# Changelog + +All notable changes to this project will be documented in this file. This project +[keeps a CHANGELOG](http://keepachangelog.com/) and adheres to +[Semantic Versioning](http://semver.org/). + + +## [UNREALEASED] 2016- + +### Added + +* ... + + +## [0.1.0] - 2016-05-02 + +### Added + +* Initial repository structure diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c444745 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contribution Guidelines + +You are most welcome to suggest improvements, or send a pull +requests. In case you find an issue, please report an +[issue](https://github.com/wwphp-fb/stats/issues) + +* Fork this repository over GitHub +* Set up your local repository + + ```bash +$ git clone git@github.com:your_username/stats +$ cd stats +$ git remote add upstream git://github.com/wwphp-fb/stats +$ git config branch.master.remote upstream +``` +* Make changes and send pull request + + ```bash +$ git add . +$ git commit -m "Fix bug" +$ git push origin +``` + + +## Release Process + +*(For repository maintainers)* + +This repository follows [semantic versioning](http://semver.org). When source +code changes or new features are implemented, a new version (e.g. `1.x.y`) is +released by the following release process: + + +* **1. Update Changelog:** + + Create an entry in [CHANGELOG.md](CHANGELOG.md) describing all the notable + changes from previous release. + +* **2. Tag new release:** + + Tag a new version on [GitHub](https://github.com/wwphp-fb/stats/releases) with + description of notable changes. diff --git a/README.md b/README.md index 365faf7..1f60fa6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Stats generator for Facebook group +[![Latest Version](https://img.shields.io/github/release/wwphp-fb/stats.svg?style=plastic)](https://github.com/wwphp-fb/stats/releases) +[![Build Status](https://travis-ci.org/wwphp-fb/stats.svg?branch=master)](https://travis-ci.org/wwphp-fb/stats) +[![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=plastic)](LICENSE.md) + PHP application for generating stats for International PHP Facebook group. ## FAQ @@ -25,7 +29,7 @@ not excluded for getting higher score than other members :) ## Installation -If you want to install this application locally, do the following: +To install this application locally, do the following: 1. Register Facebook Application @@ -110,5 +114,5 @@ If you want to install this application locally, do the following: This repository is released under the [MIT license](LICENSE). -Contributions and improvement suggestions are welcome by opening an -[issue](https://github.com/wwphp-fb/stats/issues) or sending pull request. +You are welcome to suggest improvements or open a ticket. More info in the +[CONTRIBUTING](CONTRIBUTING.md) file. diff --git a/phpunit.xml.dist b/phpunit.xml.dist index ef2401a..6447480 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -14,7 +14,7 @@ - src + src