forked from google/truth
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=98746341
- Loading branch information
Showing
2 changed files
with
59 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,56 @@ | ||
| # How to contribute # | ||
| # How to contribute | ||
|
|
||
| We'd love to accept your patches and contributions to this project. There are | ||
| a just a few small guidelines you need to follow. | ||
| We'd love to accept your patches and contributions to this project. There are a | ||
| just a few small guidelines you need to follow. | ||
|
|
||
| ## Contributor License Agreement | ||
|
|
||
| ## Contributor License Agreement ## | ||
| Contributions to any Google project must be accompanied by a Contributor License | ||
| Agreement. This is not a copyright **assignment**, it simply gives Google | ||
| permission to use and redistribute your contributions as part of the project. | ||
|
|
||
| Contributions to any Google project must be accompanied by a Contributor | ||
| License Agreement. This is not a copyright **assignment**, it simply gives | ||
| Google permission to use and redistribute your contributions as part of the | ||
| project. | ||
|
|
||
| * If you are an individual writing original source code and you're sure you | ||
| * If you are an individual writing original source code and you're sure you | ||
| own the intellectual property, then you'll need to sign an [individual | ||
| CLA][]. | ||
| CLA][individual CLA]. | ||
|
|
||
| * If you work for a company that wants to allow you to contribute your work, | ||
| then you'll need to sign a [corporate CLA][]. | ||
| * If you work for a company that wants to allow you to contribute your work, | ||
| then you'll need to sign a [corporate CLA]. | ||
|
|
||
| You generally only need to submit a CLA once, so if you've already submitted | ||
| one (even if it was for a different project), you probably don't need to do it | ||
| You generally only need to submit a CLA once, so if you've already submitted one | ||
| (even if it was for a different project), you probably don't need to do it | ||
| again. | ||
|
|
||
| [individual CLA]: https://developers.google.com/open-source/cla/individual | ||
| [corporate CLA]: https://developers.google.com/open-source/cla/corporate | ||
|
|
||
| ## Submitting a patch | ||
|
|
||
| ## Submitting a patch ## | ||
| 1. It's generally best to start by opening a new issue describing the bug or | ||
| feature you're intending to fix. Even if you think it's relatively minor, | ||
| it's helpful to know what people are working on. Mention in the initial | ||
| issue that you are planning to work on that bug or feature so that it can be | ||
| assigned to you. | ||
|
|
||
| 1. It's generally best to start by opening a new issue describing the bug or | ||
| feature you're intending to fix. Even if you think it's relatively minor, | ||
| it's helpful to know what people are working on. Mention in the initial | ||
| issue that you are planning to work on that bug or feature so that it can | ||
| be assigned to you. | ||
| 2. Follow the normal process of [forking] the project, and setup a new branch | ||
| to work in. It's important that each group of changes be done in separate | ||
| branches in order to ensure that a pull request only includes the commits | ||
| related to that bug or feature. | ||
|
|
||
| 1. Follow the normal process of [forking][] the project, and setup a new | ||
| branch to work in. It's important that each group of changes be done in | ||
| separate branches in order to ensure that a pull request only includes the | ||
| commits related to that bug or feature. | ||
| 3. Any significant changes should almost always be accompanied by tests. The | ||
| project already has good test coverage, so look at some of the existing | ||
| tests if you're unsure how to go about it. | ||
|
|
||
| 1. Any significant changes should almost always be accompanied by tests. The | ||
| project already has good test coverage, so look at some of the existing | ||
| tests if you're unsure how to go about it. | ||
|
|
||
| 1. All contributions must be licensed Apache 2.0 and all files must have | ||
| a copy of the boilerplate licence comment (can be copied from an existing | ||
| file). Files should be formatted according to Google's [java style guide][]. | ||
| 4. All contributions must be licensed Apache 2.0 and all files must have a copy | ||
| of the boilerplate licence comment (can be copied from an existing file). | ||
| Files should be formatted according to Google's [java style guide]. | ||
|
|
||
| 1. Do your best to have [well-formed commit messages][] for each change. | ||
| This provides consistency throughout the project, and ensures that commit | ||
| messages are able to be formatted properly by various git tools. | ||
| 5. Do your best to have [well-formed commit messages] for each change. This | ||
| provides consistency throughout the project, and ensures that commit | ||
| messages are able to be formatted properly by various git tools. | ||
|
|
||
| 1. Finally, push the commits to your fork and submit a [pull request][]. | ||
| 6. Finally, push the commits to your fork and submit a [pull request]. | ||
|
|
||
| [forking]: https://help.github.com/articles/fork-a-repo | ||
| [java style guide]: http://google-styleguide.googlecode.com/svn/trunk/javaguide.html | ||
| [well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
| [pull request]: https://help.github.com/articles/creating-a-pull-request | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,45 @@ | ||
| Truth | ||
| ===== | ||
|
|
||
| ***We've made failure a strategy*** | ||
|
|
||
| **Main Website:** *[google.github.io/truth](http://google.github.io/truth/)* | ||
| **Continuous Integration:** [](https://travis-ci.org/google/truth) <br /> | ||
| **Latest Release:** *0.27* | ||
| **Main Website:** *[google.github.io/truth](http://google.github.io/truth/)* | ||
| **Continuous Integration:** [] | ||
| (https://travis-ci.org/google/truth) <br /> **Latest Release:** *0.27* | ||
| **Latest Artifact:** *org.junit.contrib:truth:jar:0.27* <br /> | ||
|
|
||
| What is Truth? | ||
| -------------- | ||
|
|
||
| Truth is an assertion/proposition framework appropriate for testing, inspired by FEST, and | ||
| driven by some extensibility needs, written nearly entirely by Google employees in their spare | ||
| time or contributing in their capacity as Java core librarians. | ||
| Truth is an assertion/proposition framework appropriate for testing, inspired by | ||
| FEST, and driven by some extensibility needs, written nearly entirely by Google | ||
| employees in their spare time or contributing in their capacity as Java core | ||
| librarians. | ||
|
|
||
| Truth can be used in place of JUnit's assertions, FEST, or Hamcrest's matchers, or it can be | ||
| used alongside where other approaches seem more suitable. | ||
| Truth can be used in place of JUnit's assertions, FEST, or Hamcrest's matchers, | ||
| or it can be used alongside where other approaches seem more suitable. | ||
|
|
||
| #### The full documentation and website for Truth is available at http://google.github.io/truth | ||
|
|
||
| License | ||
| ---------------- | ||
| ------- | ||
|
|
||
| Truth is licensed under the open-source Apache 2.0 license. | ||
| Truth is licensed under the open-source Apache 2.0 license. | ||
|
|
||
| Acknowledgements | ||
| ---------------- | ||
|
|
||
| Thanks to Github and Travis-CI for having a strong commitment to open-source, and | ||
| providing us with tools so we can provide others with code. And thanks to Google | ||
| for [Guava](http://code.google.com/p/guava-libraries "Guava"), for taking on the Truth | ||
| project and making it part of their core-libraries effort, and for encouraging | ||
| us to try to solve problems in better ways and share that with the world. | ||
|
|
||
| Also thanks to the authors of JUnit, TestNG, Hamcrest, FEST, and others for creating | ||
| testing tools that let us write high-quality code, for inspiring this work and for | ||
| moving the ball forward in the field of automated software testing. This project | ||
| works with, works alongside, and sometimes works in competition with the above | ||
| tools, but owes a debt that everyone owes to those gone before. They paved the | ||
| way, and we hope this contribution is helpful to the field. | ||
| Thanks to Github and Travis-CI for having a strong commitment to open-source, | ||
| and providing us with tools so we can provide others with code. And thanks to | ||
| Google for [Guava](http://code.google.com/p/guava-libraries "Guava"), for taking | ||
| on the Truth project and making it part of their core-libraries effort, and for | ||
| encouraging us to try to solve problems in better ways and share that with the | ||
| world. | ||
|
|
||
| Also thanks to the authors of JUnit, TestNG, Hamcrest, FEST, and others for | ||
| creating testing tools that let us write high-quality code, for inspiring this | ||
| work and for moving the ball forward in the field of automated software testing. | ||
| This project works with, works alongside, and sometimes works in competition | ||
| with the above tools, but owes a debt that everyone owes to those gone before. | ||
| They paved the way, and we hope this contribution is helpful to the field. |