cubetiq/spring-authorization-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update CONTRIBUTING with commit message format

Browse Source
This commit is contained in:
Joe Grandja 2020-04-23 14:46:37 -04:00
parent 3a92eb3bcf
commit c9a7fc124c
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.adoc
View File

@ -3,15 +3,11 @@
Spring Authorization Server is released under the Apache 2.0 license. Spring Authorization Server is released under the Apache 2.0 license.
If you would like to contribute something, or simply want to hack on the code this document should help you get started. If you would like to contribute something, or simply want to hack on the code this document should help you get started.
== Code of Conduct == Code of Conduct
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct]. This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct].
By participating, you are expected to uphold this code. By participating, you are expected to uphold this code.
Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
== Using GitHub Issues == Using GitHub Issues
We use GitHub issues to track bugs and enhancements. We use GitHub issues to track bugs and enhancements.
If you have a general usage question please ask on https://stackoverflow.com[Stack Overflow]. If you have a general usage question please ask on https://stackoverflow.com[Stack Overflow].
@ -20,8 +16,6 @@ The Spring Security team and the broader community monitor the https://stackover
If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible. If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.
Ideally, that would include a https://stackoverflow.com/help/minimal-reproducible-example[complete & minimal sample project] that reproduces the problem. Ideally, that would include a https://stackoverflow.com/help/minimal-reproducible-example[complete & minimal sample project] that reproduces the problem.
== Submitting Pull Requests == Submitting Pull Requests
This project uses https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests[pull requests] for the community to suggest changes to the project. This project uses https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests[pull requests] for the community to suggest changes to the project.
There are a few imporant things to keep in mind when submitting a pull request: There are a few imporant things to keep in mind when submitting a pull request:
@ -34,15 +28,12 @@ There are a few imporant things to keep in mind when submitting a pull request:
This ensures that we are collaborating together as soon as possible. This ensures that we are collaborating together as soon as possible.
*** Generally, this means do not introduce any new interfaces and as few classes as possible. *** Generally, this means do not introduce any new interfaces and as few classes as possible.
That may mean using an external library directly in a `Filter`. That may mean using an external library directly in a `Filter`.
*** We will discuss with you how to iterate once you have submitted the initial draft pull request. *** We will discuss with you how to iterate once you have submitted the initial draft pull request.
== Reporting Security Vulnerabilities == Reporting Security Vulnerabilities
If you think you have found a security vulnerability please *DO NOT* disclose it publicly until we've had a chance to fix it. If you think you have found a security vulnerability please *DO NOT* disclose it publicly until we've had a chance to fix it.
Please don't report security vulnerabilities using GitHub issues, instead head over to https://pivotal.io/security and learn how to disclose them responsibly. Please don't report security vulnerabilities using GitHub issues, instead head over to https://pivotal.io/security and learn how to disclose them responsibly.
== Sign the Contributor License Agreement == Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to https://cla.pivotal.io/sign/spring[sign the Contributor License Agreement]. Before we accept a non-trivial patch or pull request we will need you to https://cla.pivotal.io/sign/spring[sign the Contributor License Agreement].
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. 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.
@ -68,4 +59,16 @@ Please add the Apache License header to all new classes, for example:
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
``` ```
== Squash commits
Use git rebase –interactive, git add –patch and other tools to "squash" multiple commits into atomic changes.
== Format commit messages
. Keep the subject line to 50 characters or less if possible.
. Do not end the subject line with a period.
. In the body of the commit message, explain how things worked before this commit, what has changed, and how things work now.
. Include Fixes gh-<issue-number> at the end if this fixes a GitHub issue.
. Avoid markdown, including back-ticks identifying code.