summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKurt Jung <kurt.w.jung@gmail.com>2015-10-10 16:17:06 -0400
committerKurt Jung <kurt.w.jung@gmail.com>2015-10-10 16:17:06 -0400
commita44575e274cee9b42d443f7ae8103990228c47ac (patch)
treee973ba6ee74861bdeec4ffab9a106349e6994739
parent0984c75c9d917af4881f5963d7396288c96a4436 (diff)
Grammar tweak in documentation
-rw-r--r--README.md5
-rw-r--r--doc.go6
2 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 398025b..95fe304 100644
--- a/README.md
+++ b/README.md
@@ -136,14 +136,15 @@ gofpdf for its document production mode.
gofpdf is a global community effort and you are invited to make it even better.
If you have implemented a new feature or corrected a problem, please consider
-contributing your change to the project. Contributions that do not directly
-pertain to the core functionality of gofpdf should be placed in their own
+contributing your change to the project. A contribution that does not directly
+pertain to the core functionality of gofpdf should be placed in its own
directory directly beneath the `contrib` directory.
Here are guidelines for making submissions. Your change should
* be compatible with the MIT License
* be properly documented
+* be formatted with `go fmt`
* include an example in [fpdf_test.go](https://github.com/jung-kurt/gofpdf/blob/master/fpdf_test.go) if appropriate
* conform to the standards of [golint](https://github.com/golang/lint) and
[go vet](https://godoc.org/golang.org/x/tools/cmd/vet), that is, `golint .` and
diff --git a/doc.go b/doc.go
index 3f2d3b5..3dd09ef 100644
--- a/doc.go
+++ b/doc.go
@@ -150,8 +150,8 @@ Contributing Changes
gofpdf is a global community effort and you are invited to make it even better.
If you have implemented a new feature or corrected a problem, please consider
-contributing your change to the project. Contributions that do not directly
-pertain to the core functionality of gofpdf should be placed in their own
+contributing your change to the project. A contribution that does not directly
+pertain to the core functionality of gofpdf should be placed in its own
directory directly beneath the `contrib` directory.
Here are guidelines for making submissions. Your change should
@@ -160,6 +160,8 @@ Here are guidelines for making submissions. Your change should
• be properly documented
+• be formatted with `go fmt`
+
• include an example in fpdf_test.go if appropriate
• conform to the standards of golint (https://github.com/golang/lint) and