Skip to content

Commit

Permalink
Massive documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
GrahamCampbell committed Feb 24, 2014
1 parent 619f304 commit 52f4dfe
Show file tree
Hide file tree
Showing 28 changed files with 1,592 additions and 1,583 deletions.
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# 0.9.0 (2014-02-05)
# Change Log


## 0.9.0 (2014-02-05)

* Allow mocking classes with final __wakeup() method
* Quick definitions are now always `byDefault`
* Allow mocking of protected methods with `shouldAllowMockingProtectedMethods`
* Support offical Hamcrest package
* Support official Hamcrest package
* Generator completely rewritten
* Easily create named mocks with namedMock
36 changes: 25 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# How to contribute
# Contributing


We'd love you to help out with mockery and no contribution is too small.


## Reporting Bugs

Issues can be reported on the [issue
tracker](https://github.com/padraic/mockery/issues). Please try and report any
bugs with a minimal reproducible example, it will make things easier for other
contributors and your problems will hopefully be resolved quickly.


## Requesting Features

We're always interested to hear about your ideas and you can request features by
Expand All @@ -21,38 +24,49 @@ Likewise, if a feature you would like is already listed in
the issue tracker, add a :+1: so that other contributors know it's a feature
that would help others.


## Contributing code and documentation

* Fork the [repository](https://github.com/padraic/mockery) on github.
* Add some tests for your feature or bug
* Fork the [repository](https://github.com/padraic/mockery) on GitHub
* Add the code for your feature or bug
* Add some tests for your feature or bug
* Optionally, but preferably, write some documentation (currently in README.md)
* Optionally update the CHANGELOG.md file with your feature or
* Optionally, update the CHANGELOG.md file with your feature or
[BC](http://en.wikipedia.org/wiki/Backward_compatibility) break
* Send a [Pull
Request](https://help.github.com/articles/creating-a-pull-request) to the correct target branch (see below)
Request](https://help.github.com/articles/creating-a-pull-request) to the
correct target branch (see below)

If you have a big change or would like to discuss something, create an issue in
the [issue tracker](https://github.com/padraic/mockery/issues) or jump in to
\#mockery on freenode


Any code you contribute must be licensed under the [BSD 3-Clause
License](http://opensource.org/licenses/BSD-3-Clause).

# Target Branch

## Target Branch

Mockery may have several active branches at any one time and roughly follows a
[Git Branching Model](https://igor.io/2013/10/21/git-branching-model.html).
Generally, if you're developing a new feature, you want to be targetting the
Generally, if you're developing a new feature, you want to be targeting the
master branch, if it's a bug fix, you want to be targeting a release branch,
e.g. 0.8.

# Testing Mockery

Mockery relies on PHPUnit 4 to run unit tests. To run Mockery's unit tests,
please run `composer install --dev` then `vendor/bin/phpunit`.
## Testing Mockery

To run the unit tests for Mockery, clone the git repository, download Composer using
the instructions at [http://getcomposer.org/download/](http://getcomposer.org/download/),
then install the dependencies with `php /path/to/composer.phar install --dev`.

This will install the required PHPUnit and Hamcrest dev dependencies and create the
autoload files required by the unit tests. You may run the `vendor/bin/phpunit` command
to run the unit tests. If everything goes to plan, there will be no failed tests!


# Debugging Mockery
## Debugging Mockery

Mockery and it's code generation can be difficult to debug. A good start is to
use the `RequireLoader`, which will dump the code generated by mockery to a file
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2010-2013, Pádraic Brady
Copyright (c) 2010-2014, Pádraic Brady
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand Down
Loading

0 comments on commit 52f4dfe

Please sign in to comment.