Merge branch '1.0.x'
This commit is contained in:
46
CODE_OF_CONDUCT.md
Normal file
46
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Contributor 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.
|
||||
|
||||
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.
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery
|
||||
* Personal attacks
|
||||
* Trolling or insulting/derogatory comments
|
||||
* Public or private harassment
|
||||
* Publishing other's private information, such as physical or electronic addresses,
|
||||
without explicit permission
|
||||
* Other unethical or unprofessional conduct
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an
|
||||
individual is representing the project or its community.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
|
||||
contacting a project maintainer at spring-code-of-conduct@pivotal.io. All complaints will
|
||||
be reviewed and investigated and will result in a response that is deemed necessary and
|
||||
appropriate to the circumstances. Maintainers are obligated to maintain confidentiality
|
||||
with regard to the reporter of an incident.
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][1], version 1.3.0, available
|
||||
at [contributor-covenant.org/version/1/3/0/][2].
|
||||
|
||||
[1]: http://contributor-covenant.org
|
||||
[2]: http://contributor-covenant.org/version/1/3/0/
|
||||
@@ -4,10 +4,16 @@ Spring REST Docs is released under the Apache 2.0 license. If you would like to
|
||||
contribute something, or simply want to work with the code, this document should help you
|
||||
to get started.
|
||||
|
||||
## Code of conduct
|
||||
|
||||
This project adheres to the Contributor Covenant [code of conduct][1]. By participating,
|
||||
you are expected to uphold this code. Please report unacceptable behavior to
|
||||
spring-code-of-conduct@pivotal.io.
|
||||
|
||||
## Sign the contributor license agreement
|
||||
|
||||
Before we accept a non-trivial patch or pull request we will need you to sign the
|
||||
[contributor's license agreement (CLA)][1]. Signing the contributor's agreement does not
|
||||
[contributor's license agreement (CLA)][2]. Signing the contributor's agreement does not
|
||||
grant anyone commit rights to the main repository, but it does mean that we can accept
|
||||
your contributions, and you will get an author credit if we do. Please use "Andy
|
||||
Wilkinson" in the project lead field when you complete the form.
|
||||
@@ -28,7 +34,7 @@ None of these is essential for a pull request, but they will all help
|
||||
- Add unit tests that covers and new or modified functionality
|
||||
- Whenever possible, please rebase your branch against the current master (or other
|
||||
target branch in the main project).
|
||||
* When writing a commit message please follow [these conventions][2]. Also, if you are
|
||||
* When writing a commit message please follow [these conventions][3]. Also, if you are
|
||||
fixing an existing issue please add `Fixes gh-nnn` at the end of the commit message
|
||||
(where nnn is the issue number).
|
||||
|
||||
@@ -54,5 +60,6 @@ $ ./gradlew eclipse
|
||||
The project can then be imported into Eclipse using `File -> Import…` and then selecting
|
||||
`General -> Existing Projects into Workspace`.
|
||||
|
||||
[1]: https://support.springsource.com/spring_committer_signup
|
||||
[2]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
||||
[1]: CODE_OF_CONDUCT.md
|
||||
[2]: https://support.springsource.com/spring_committer_signup
|
||||
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
||||
12
README.md
12
README.md
@@ -25,11 +25,12 @@ Spring REST Docs requires Java 7 or later and is built using [Gradle][10]:
|
||||
|
||||
## Contributing
|
||||
|
||||
[Pull requests][11] are welcome. Please see the [contributor guidelines][12] for details.
|
||||
Contributors to this project agree to uphold its [code of conduct][11].
|
||||
[Pull requests][12] are welcome. Please see the [contributor guidelines][13] for details.
|
||||
|
||||
## Licence
|
||||
|
||||
Spring REST Docs is open source software released under the [Apache 2.0 license][13].
|
||||
Spring REST Docs is open source software released under the [Apache 2.0 license][14].
|
||||
|
||||
[1]: https://build.spring.io/plugins/servlet/buildStatusImage/SRD-PUB (Build status)
|
||||
[2]: https://build.spring.io/browse/SRD-PUB
|
||||
@@ -41,7 +42,8 @@ Spring REST Docs is open source software released under the [Apache 2.0 license]
|
||||
[8]: https://www.youtube.com/watch?v=knH5ihPNiUs&feature=youtu.be
|
||||
[9]: http://docs.spring.io/spring-restdocs/docs/
|
||||
[10]: http://gradle.org
|
||||
[11]: https://help.github.com/articles/using-pull-requests/
|
||||
[12]: https://github.com/spring-projects/spring-restdocs/blob/master/CONTRIBUTING.md
|
||||
[13]: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
[11]: CODE_OF_CONDUCT.md
|
||||
[12]: https://help.github.com/articles/using-pull-requests/
|
||||
[13]: CONTRIBUTING.md
|
||||
[14]: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
|
||||
|
||||
Reference in New Issue
Block a user