Spring/spring-session-data-mongodb-examples
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add README

Browse Source
This commit is contained in:
Greg Turnquist
2017-08-23 14:15:20 -05:00
parent c4168e6972
commit dd7c985d59
1 changed files with 46 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.adoc Normal file
View File

@@ -0,0 +1,46 @@
= 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"]
This repository is a collection of examples using Spring Session MongoDB, allowing you to persist session data in a MongoDB instance.
== Examples
* link:spring-session-data-mongodb-reactive-boot[Spring Session MongoDB in a Reactive Spring Boot application (Spring WebFlux)]
* link:spring-session-data-mongodb-traditional-boot[Spring Session MongoDB in a traditional Spring Boot application (Spring MVC)]
== Contributing
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
to contribute even something trivial please do not hesitate, but
follow the guidelines below.
=== Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to sign the
https://cla.pivotal.io/sign/spring[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. Active contributors might be asked to join the core team, and
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.
=== 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 http://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).
* When writing a commit message please follow http://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.