Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
#A quick guide to contribute to the project:
# A quick guide to contribute to the project:

##Installing the dev environment
## Installing the dev environment

1. Fork the repo
2. Clone the repo to local
3. Install dependencies: `composer install` (this assumes you have 'composer' aliased to whereever your composer.phar lives)
4. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate:
`./bin/phpspec run --format=pretty`

##The actual contribution
## The actual contribution

1. Make the changes/additions to the code, committing often and making clear what you've done
2. Make sure you write tests for your code, located in the folder structure `spec/Coduo/PHPHumanizer/...`
3. Run your tests (often and while coding): `./bin/phpspec run --format=pretty`

##Coding Standards
## Coding Standards

Try use similar coding standards to what you see in the project to keep things clear to the contributors. If you're unsure, it's always a safe bet to fall-back to the PSR standards.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#PHP Humanizer
# PHP Humanizer

[![Build Status](https://travis-ci.org/coduo/php-humanizer.svg?branch=master)](https://travis-ci.org/coduo/php-humanizer)
[![Latest Stable Version](https://poser.pugx.org/coduo/php-humanizer/v/stable)](https://packagist.org/packages/coduo/php-humanizer)
Expand All @@ -8,15 +8,15 @@

Humanize values to make them readable for regular people ;)

#Installation
# Installation

Run the following command:

```shell
composer require coduo/php-humanizer
```

#Usage
# Usage

## Text

Expand Down