Skip to content
This repository has been archived by the owner on Jul 15, 2020. It is now read-only.

Latest commit

 

History

History
108 lines (75 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

108 lines (75 loc) · 3.44 KB
Raw

Contribution Guidelines

You are most welcome to suggest improvements, send pull requests or open an issue

  • Fork this repository over GitHub

  • Set up your local repository

    

    • 



git clone [email protected]:your_username/stats
cd stats
git remote add upstream git://github.com/php-earth/stats
git config branch.master.remote upstream



* Make changes and send pull request

  ```bash
git add .
git commit -m "Fix bug"
git push origin



Code follows PSR-1, PSR-2
and extended code style guide proposal.
Documentation uses Markdown
syntax and follows cirosantilli/markdown-style-guide
style guide.


To run tests:


phpunit


Translations


Translation messages for the generated stats report are in YAML
format and are located in the app/translations folder.
Translations use the
Symfony Translation Component.
Variables in messages are in the format %variable%.


Pluralization for languages with multiple pluralization formats:


    

  • 

    English and languages with 1 plural format:
    

    "1 comment|%count% comments"
    

    • 

  • 

    Languages with 2 plural formats - first for 1 item, second for 2 items and third
for 3 or more items. For example, Russian:
    

    "1 комментарий|%count% комментария|%count% комментариев"
    

    • 

  • 

    Languages with 3 plural formats - first for 1 item, second for 2 items, third
for 3 and 4 items and fourth for 5 or more items. For example, Slovenian:
    

    "1 komentar|%count% komentarja|%count% komentarji|%count% komentarjev"
    

    • 



GitHub Issues Labels


Labels are used to organize issues and pull requests into manageable categories.
The following labels are used:


    

  • Bug - Attached for bugs.
    • 

  • Duplicate - Attached when the same issue or pull request already exists.
    • 

  • Enhancement - New feature.
    • 

  • Hacktoberfest - Attached for open source [Hacktoberfest] event.
    • 

  • Invalid - Attached when
    • 

  • Needs Review - Attached when further review is required.
    • 

  • Question - Attached for questions or discussions.
    • 

  • Request - Attached for new feature requests.
    • 

  • Wontfix - Attached when decided that issue will not be fixed.
    • 



Release Process


(For repository maintainers)


This repository follows semantic versioning. 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. Code Quality:
    

    Make sure tests pass:
    

    

    • 



phpunit



    Before releasing new version, check status on
    [Scrutinizer](https://scrutinizer-ci.com/g/php-earth/stats/),
    [Travis CI](https://travis-ci.org/php-earth/stats) and
    [SensioLabsInsight](https://insight.sensiolabs.com/projects/c317a2f5-1fbe-4d76-a93c-8f0d98e61ef6)

* **2. Update Changelog:**

    Create an entry in [CHANGELOG.md](CHANGELOG.md) describing all the notable
    changes from previous release.

* **3. Tag New Release:**

    Tag a new version on [GitHub](https://github.com/php-earth/stats/releases)
    with description of notable changes.

* **4. Update version** in `app/bootstrap.php`.


[Hacktoberfest]: https://hacktoberfest.digitalocean.com/