Skip to content

Commit

Permalink
Add a change log and contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
klaude committed Feb 23, 2016
1 parent 33a8e76 commit ee08566
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Change Log

## Version 0.1.1
**Released 23 February, 2016**
* Fix a typo in an internal method name ([#1](https:/klaude/eloquent-preferences/issues/1) - Thanks, [@timothyallan](https:/timothyallan)!)
* Replace a deprecated PHPUnit configuration option
* Add contributing guidelines and a change log

## Version 0.1.0
**Released 27 December, 2015**
* Initial release
* Basic support for preference retrieval, creation, updating, and deletion
* Support for preference value type casting
* Support for default preference values
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# How to contribute

Thanks for wanting to help! Seriously, that's awesome.

## Reporting bugs

Most of the time we don't know there's a problem unless someone tells us, so thanks a bunch for reporting bugs. Please [open an issue](https:/klaude/eloquent-preferences/issues/new) describing the bug, when it started, and if anything changed in your project around the time it started. More information is always better. If possible please include the PHP and Eloquent versions you're using and if you're using Eloquent on its own or as part of the Laravel framework.

## Contributing code

[Pull requests](https:/klaude/eloquent-preferences/pulls) are always welcome. Please keep the following in mind if you want to submit new work:

* This library targets currently supported versions of PHP and HHVM.
* This library targets Eloquent 5.0 and above and should work in the latest published 5.x minor versions.
* [.travis.yml](https:/klaude/eloquent-preferences/blob/master/.travis.yml) is configured to test on all possible PHP/HHVM and Eloquent versions. If TravisCI builds succeed then that's good enough for me.
* New code should work with Eloquent both standalone and as part of the full Laravel framework. It requires [illuminate/support](https:/illuminate/support) in addition to Eloquent, but don't assume that users will be using the full framework.
* New code should adhere to the currently accepted [PHP Standards Recommendations (PSRs)](http://www.php-fig.org/psr/).
* New code should include unit tests. Use the existing ones as a guideline, and try to shoot for 80% code coverage or more in your tests.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build Status](https://travis-ci.org/klaude/eloquent-preferences.png)](https://travis-ci.org/klaude/eloquent-preferences)

Use this library to bind multiple key/value pair preferences to your application's Eloquent models. Preferences are stored in your application's database so they can be easily stored and queried for. This library currently only supports Eloquent 5.x installed either standalone or as a part of the full Laravel framework. Issues and pull requests are welcome!
Use this library to bind multiple key/value pair preferences to your application's Eloquent models. Preferences are stored in your application's database so they can be easily stored and queried for. This library currently only supports Eloquent 5.x installed either standalone or as a part of the full Laravel framework. Issues and pull requests are welcome! See [CONTRIBUTING.md](https:/klaude/eloquent-preferences/blob/master/CONTRIBUTING.md) for more information.

* [Installation](#installation)
* [Configuring In Laravel](#configuring-in-laravel)
Expand Down

0 comments on commit ee08566

Please sign in to comment.