mirror of
https://github.com/google/guava.git
synced 2026-10-28 08:35:50 +08:00
Format some Markdown.
RELNOTES=n/a PiperOrigin-RevId: 984055579
This commit is contained in:
1 parent
794fa736c9
commit
77b2cf6b92
2 files changed
+26
-32
No files matched your search
+17
-22
@@ -1,5 +1,4 @@
|
||||
How to contribute
|
||||
=================
|
||||
# How to contribute
|
||||
|
||||
Thank you so much for wanting to contribute to Guava! Here are a few important
|
||||
things you should know about contributing:
|
||||
@@ -9,8 +8,7 @@ things you should know about contributing:
|
||||
3. Pull requests are not merged directly into the master branch.
|
||||
4. Code contributions require signing a Google CLA.
|
||||
|
||||
API changes
|
||||
-----------
|
||||
## API changes
|
||||
|
||||
We make changes to Guava's public [APIs][], including adding new APIs, very
|
||||
carefully. Because of this, if you're interested in seeing a new feature in
|
||||
@@ -24,8 +22,7 @@ of API design and review. Any code should come after this.
|
||||
[APIs]: https://en.wikipedia.org/wiki/API
|
||||
[issue]: https://github.com/google/guava/issues
|
||||
|
||||
Pull requests
|
||||
-------------
|
||||
## Pull requests
|
||||
|
||||
Unless the change is a trivial fix such as for a typo, it's generally best to
|
||||
start by opening a new issue describing the bug or feature you're intending to
|
||||
@@ -35,9 +32,9 @@ thoroughly before moving to code.
|
||||
|
||||
Some examples of types of pull requests that are immediately helpful:
|
||||
|
||||
- Fixing a bug without changing a public API.
|
||||
- Fixing or improving documentation.
|
||||
- Improvements to Maven configuration.
|
||||
- Fixing a bug without changing a public API.
|
||||
- Fixing or improving documentation.
|
||||
- Improvements to Maven configuration.
|
||||
|
||||
Guidelines for any code contributions:
|
||||
|
||||
@@ -55,7 +52,7 @@ Guidelines for any code contributions:
|
||||
[Java style guide]: https://google.github.io/styleguide/javaguide.html
|
||||
[well-formed commit message]: https://google.github.io/eng-practices/review/developer/cl-descriptions.html
|
||||
|
||||
#### Merging pull requests ####
|
||||
#### Merging pull requests
|
||||
|
||||
Due to Guava's nature as a subset of Google's internal codebase which is
|
||||
automatically synced to the public GitHub repository, we are unable to merge
|
||||
@@ -64,22 +61,20 @@ ready for merging, we'll make the appropriate changes in the internal codebase
|
||||
and, when the change is synced out, give the pull request author credit for the
|
||||
commit.
|
||||
|
||||
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
|
||||
own the intellectual property, then you'll need to sign an [individual
|
||||
CLA][]. Please include your GitHub username.
|
||||
- If you work for a company that wants to allow you to contribute your work,
|
||||
- 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][]. Please include your GitHub username.
|
||||
- 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://cla.developers.google.com/about/google-individual
|
||||
|
||||
+9
-10
@@ -1,11 +1,11 @@
|
||||
# Guava Testlib: Google Testing Libraries for Java
|
||||
|
||||
Guava testlib is a set of Java classes for more convenient
|
||||
unit testing.
|
||||
Guava testlib is a set of Java classes for more convenient unit testing.
|
||||
|
||||
## Adding Guava Testlib to your build
|
||||
|
||||
Guava testlib's Maven group ID is `com.google.guava` and its artifact ID is `guava-testlib`.
|
||||
Guava testlib's Maven group ID is `com.google.guava` and its artifact ID is
|
||||
`guava-testlib`.
|
||||
|
||||
To add a dependency on Guava testlib using Maven, use the following:
|
||||
|
||||
@@ -36,13 +36,12 @@ dependencies {
|
||||
|
||||
## IMPORTANT WARNINGS
|
||||
|
||||
1. APIs marked with the `@Beta` annotation at the class or method level
|
||||
are subject to change. They can be modified in any way, or even
|
||||
removed, at any time. If your code is a library itself (i.e. it is
|
||||
used on the CLASSPATH of users outside your own control), you should
|
||||
not use beta APIs, unless you [repackage] them. **If your
|
||||
code is a library, we strongly recommend using the [Guava Beta Checker] to
|
||||
ensure that you do not use any `@Beta` APIs!**
|
||||
1. APIs marked with the `@Beta` annotation at the class or method level are
|
||||
subject to change. They can be modified in any way, or even removed, at any
|
||||
time. If your code is a library itself (i.e. it is used on the CLASSPATH of
|
||||
users outside your own control), you should not use beta APIs, unless you
|
||||
[repackage] them. **If your code is a library, we strongly recommend using
|
||||
the [Guava Beta Checker] to ensure that you do not use any `@Beta` APIs!**
|
||||
|
||||
[Guava Beta Checker]: https://github.com/google/guava-beta-checker
|
||||
|
||||
|
||||
Reference in new issue
Block a user