Polishing.
This commit is contained in:
10
README.adoc
10
README.adoc
@@ -1,6 +1,6 @@
|
||||
= Spring Session MongoDB Examples
|
||||
|
||||
image:https://travis-ci.org/spring-projects/spring-session-data-mongodb-examples.svg?branch=master["Build Status", link="https://travis-ci.org/spring-projects/spring-session-data-mongodb-examples"]
|
||||
image:https://travis-ci.org/spring-projects/spring-session-data-mongodb-examples.svg?branch=main["Build Status", link="https://travis-ci.org/spring-projects/spring-session-data-mongodb-examples"]
|
||||
|
||||
This repository is a collection of examples using Spring Session MongoDB, allowing you to persist session data in a MongoDB instance.
|
||||
|
||||
@@ -13,7 +13,7 @@ This repository is a collection of examples using Spring Session MongoDB, allowi
|
||||
|
||||
Spring Session MongoDB Examples is released under the non-restrictive Apache 2.0 license,
|
||||
and follows a very standard Github development process, using Github
|
||||
tracker for issues and merging pull requests into master. If you want
|
||||
tracker for issues and merging pull requests into main. If you want
|
||||
to contribute even something trivial please do not hesitate, but
|
||||
follow the guidelines below.
|
||||
|
||||
@@ -28,19 +28,19 @@ given the ability to merge pull requests.
|
||||
|
||||
=== Code of Conduct
|
||||
|
||||
This project adheres to the Contributor Covenant https://github.com/spring-projects/spring-session-data-mongodb/blob/master/CODE_OF_CONDUCT.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
||||
This project adheres to the Contributor Covenant https://github.com/spring-projects/spring-session-data-mongodb/blob/main/CODE_OF_CONDUCT.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
||||
|
||||
=== Code Conventions and Housekeeping
|
||||
|
||||
None of these is essential for a pull request, but they will all help. They can also be
|
||||
added after the original pull request but before a merge.
|
||||
|
||||
* Use the Spring Data code format conventions. If you use Eclipse you can import formatter settings using the `eclipse-code-formatter.xml` file from the https://raw.githubusercontent.com/spring-projects/spring-data-build/master/etc/ide/eclipse-formatting.xml[Spring Data Build] project. If using IntelliJ, you can use the https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin] to import the same file.
|
||||
* Use the Spring Data code format conventions. If you use Eclipse you can import formatter settings using the `eclipse-code-formatter.xml` file from the https://raw.githubusercontent.com/spring-projects/spring-data-build/main/etc/ide/eclipse-formatting.xml[Spring Data Build] project. If using IntelliJ, you can use the https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin] to import the same file.
|
||||
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an `@author` tag identifying you, and preferably at least a paragraph on what the class is for.
|
||||
* Add the ASF license header comment to all new `.java` files (copy from existing files in the project)
|
||||
* Add yourself as an `@author` to the .java files that you modify substantially (more than cosmetic changes).
|
||||
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
|
||||
* A few unit tests would help a lot as well -- someone has to do it.
|
||||
* If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
|
||||
* If no-one else is using your branch, please rebase it against the current main (or other target branch in the main project).
|
||||
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit message (where XXXX is the issue number).
|
||||
* By the way, any contributions are likely to be polished. Don't worry! Just use it as a learning experience as you are slowly jürgenized.
|
||||
Reference in New Issue
Block a user