This is an automated email from the ASF dual-hosted git repository.
liuxun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 1fdd707 SUBMARINE-794. Update submarine-cloud-v2/README.md to enforce
coding style
1fdd707 is described below
commit 1fdd707a5b6b03ea08b5e54540dd1753a22a8419
Author: MortalHappiness <[email protected]>
AuthorDate: Mon May 3 00:11:15 2021 +0800
SUBMARINE-794. Update submarine-cloud-v2/README.md to enforce coding style
### What is this PR for?
Update README.md in submarine-cloud-v2 about code formatting.
### What type of PR is it?
[Improvement]
### Todos
### What is the Jira issue?
https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE-794
### How should this be tested?
https://travis-ci.org/github/MortalHappiness/submarine
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: MortalHappiness <[email protected]>
Signed-off-by: Liu Xun <[email protected]>
Closes #576 from MortalHappiness/SUBMARINE-794 and squashes the following
commits:
d846ad6 [MortalHappiness] SUBMARINE-794. Update submarine-cloud-v2/README.md
---
submarine-cloud-v2/README.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/submarine-cloud-v2/README.md b/submarine-cloud-v2/README.md
index 6ab5ce8..779fedc 100644
--- a/submarine-cloud-v2/README.md
+++ b/submarine-cloud-v2/README.md
@@ -1,6 +1,12 @@
# Why submarine-cloud-v2?
* Because `submarine-cloud` is outdated, `submarine-cloud-v2` is the
refactored version of `submarine-cloud`. In addition, after
`submarine-cloud-v2` finishes, we will replace `submarine-cloud` with
`submarine-cloud-v2`.
+# Formatting the code
+
+For `go` files, please use [gofmt](https://golang.org/pkg/cmd/gofmt/) to
format the code.
+
+For `yaml` files, please use [prettier](https://prettier.io/) to format the
code.
+
# Initialization
```bash
go mod vendor
@@ -95,4 +101,4 @@ helm.HelmUninstall("helm-install-example-release",
helmActionConfig)
```
helm ls
helm uninstall helm-install-example-release
-```
\ No newline at end of file
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
