Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
marcospassos committed Jun 30, 2017
1 parent c88b9f6 commit 513f5d6
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 42 deletions.
76 changes: 64 additions & 12 deletions CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,74 @@
# Contributor Code of Conduct
# Contributor Covenant Code of Conduct

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
## Our Pledge

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
* Other unethical or unprofessional conduct.
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at marcos@marcospassos.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community in a direct capacity. Personal views, beliefs and values of individuals do not necessarily reflect those of the organisation or affiliated individuals and organisations.
## Attribution

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
25 changes: 16 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,38 @@

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests on [Github](https://github.com/marcospassos/phpcommon-comparison).
We accept contributions via Pull Requests on [Github][repository].


## Pull Requests

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
- **Document any change in behaviour** - Make sure the `README.md` and any
other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
- **Consider our release cycle** - We try to follow
[SemVer v2.0.0][semver]. Randomly breaking public APIs is not an option.

- **Create feature branches** - Don't ask us to pull from your master branch.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
- **One pull request per feature** - If you want to do more than one thing,
send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
- **Send coherent history** - Make sure each individual commit in your pull
request is meaningful. If you had to make multiple intermediate commits while
developing, please [squash them][git-book-squash] before submitting.


## Running Tests

``` bash
$ composer test
$ mvn test
```

**Happy coding**!


**Happy coding**!
[repository]: https://github.com/marcospassos/java-php-serializer
[semver]: http://semver.org/
[git-book-squash]: http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
46 changes: 25 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
PHP Serializer for Java
=======================
[![Build Status][img-travis-badge]][link-travis-status]
[![Coverage Status][img-coverall-badge]][link-coverall-status]
[![Build Status][travis-badge]][travis-status]
[![Coverage Status][coverall-badge]][coverall-status]
[![Java 7+][java-badge]][java]
[![License][mit-license-badge]](LICENSE)

A Java library for serializing objects as PHP serialization format.

Expand All @@ -17,7 +19,7 @@ includes:
>
> This library does not provide any mechanism for creating a communication
> channel between Java and PHP. For such purpose consider using
[Soluble Java][link-soluble-java].
[Soluble Java][soluble-java].

## Use case

Expand All @@ -43,7 +45,7 @@ that encapsulates the complexity of the serialization process.
### Maven

The PHP Serializer is available in the
[Maven Central repository][link-maven-central].
[Maven Central repository][maven-central].
Any Maven based project can use it directly by adding the appropriate entries
to the `dependencies` section of its `pom.xml` file:

Expand All @@ -59,7 +61,7 @@ to the `dependencies` section of its `pom.xml` file:

### Binaries

Packaged JARs can be downloaded directly from the [releases page][link-releases]
Packaged JARs can be downloaded directly from the [releases page][releases-page]
and extracted using tar or unzip.

## Usage
Expand Down Expand Up @@ -179,9 +181,9 @@ recently.

Contributions to the package are always welcome!

* Report any bugs or issues you find on the [issue tracker][link-issue-tracker].
* Report any bugs or issues you find on the [issue tracker][issue-tracker].
* You can grab the source code at the package's
[Git repository][link-repository].
[Git repository][repository].

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for
details.
Expand All @@ -193,8 +195,8 @@ marcos@marcospassos.com instead of using the issue tracker.

## Credits

* [Marcos Passos][link-author]
- [All Contributors][link-contributors]
* [Marcos Passos][author-page]
- [All Contributors][contributors-page]


## License
Expand Down Expand Up @@ -223,15 +225,17 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
```

[img-coverall-badge]: https://coveralls.io/repos/github/marcospassos/java-php-serializer/badge.svg
[link-coverall-status]: https://coveralls.io/github/marcospassos/java-php-serializer
[img-coverall-badge]: https://coveralls.io/repos/github/marcospassos/java-php-serializer/badge.svg
[img-travis-badge]: https://travis-ci.org/marcospassos/java-php-serializer.svg?branch=master
[link-travis-status]: https://travis-ci.org/marcospassos/java-php-serializer
[link-maven-central]: https://maven-badges.herokuapp.com/maven-central/com.marcospassos/phpserializer
[link-soluble-java]: https://github.com/belgattitude/soluble-japha
[link-author]: http://github.com/marcospassos
[link-contributors]: https://github.com/marcospassos/java-php-serializer/graphs/contributors
[link-issue-tracker]: https://github.com/marcospassos/java-php-serializer/issues
[link-repository]: https://github.com/marcospassos/java-php-serializer
[link-releases]: https://github.com/marcospassos/java-php-serializer/releases
[coverall-status]: https://coveralls.io/github/marcospassos/java-php-serializer
[coverall-badge]: https://coveralls.io/repos/github/marcospassos/java-php-serializer/badge.svg
[travis-badge]: https://travis-ci.org/marcospassos/java-php-serializer.svg?branch=master
[travis-status]: https://travis-ci.org/marcospassos/java-php-serializer
[java-badge]: https://img.shields.io/badge/java-7+-4c7e9f.svg
[java]: http://java.oracle.com
[mit-license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[maven-central]: https://maven-badges.herokuapp.com/maven-central/com.marcospassos/phpserializer
[soluble-java]: https://github.com/belgattitude/soluble-japha
[author-page]: http://github.com/marcospassos
[contributors-page]: https://github.com/marcospassos/java-php-serializer/graphs/contributors
[issue-tracker]: https://github.com/marcospassos/java-php-serializer/issues
[repository]: https://github.com/marcospassos/java-php-serializer
[releases-page]: https://github.com/marcospassos/java-php-serializer/releases

0 comments on commit 513f5d6

Please sign in to comment.