From 65ce68ebaa2b8754d053c0388a2194c2156303ec Mon Sep 17 00:00:00 2001 From: xiaojing Date: Tue, 29 Jan 2019 10:08:44 +0800 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 8b073b6165..3d5172e1c3 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,28 @@ During the incubation period, the version management of the project will follow * Functional updates will be reflected in the 3rd number of the version, for example, the next version of 0.1.0 will be 0.1.1. +## Code of Conduct +This project adheres to the Contributor Covenant 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 Framework code format conventions. If you use Eclipse you can import formatter settings using the eclipse-code-formatter.xml file from the Spring Cloud Build project. If using IntelliJ, you can use the 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 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). + ## Contact Us Mailing list is recommended for discussing almost anything related to spring-cloud-alibaba.