diff options
| -rw-r--r-- | README.md | 19 | ||||
| -rw-r--r-- | doc.go | 22 | ||||
| -rwxr-xr-x | mkdoc | 5 |
3 files changed, 46 insertions, 0 deletions
@@ -129,6 +129,25 @@ The [draw2d](https://github.com/llgcode/draw2d) package is a two dimensional vector graphics library that can generate output in different forms. It uses gofpdf for its document production mode. +##Contributing Changes + + +gofpdf is a global community effort and you are invited to make it even better. +If you have implmented a new feature or corrected a problem, please consider +contributing your change to the project. Here are guidelines for making +submissions. Your change should + +* be compatible with the MIT License +* be properly documented +* 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 +`go vet .` should not generate any warnings +* not diminish [test coverage](https://blog.golang.org/cover) + +[Pull requests](https://help.github.com/articles/using-pull-requests/) work +nicely as a means of contributing your changes. + ##License @@ -143,6 +143,28 @@ The draw2d package (https://github.com/llgcode/draw2d) is a two dimensional vector graphics library that can generate output in different forms. It uses gofpdf for its document production mode. +Contributing Changes + +gofpdf is a global community effort and you are invited to make it even better. +If you have implmented a new feature or corrected a problem, please consider +contributing your change to the project. Here are guidelines for making +submissions. Your change should + +• be compatible with the MIT License + +• be properly documented + +• include an example in 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 +`go vet .` should not generate any warnings + +• not diminish test coverage (https://blog.golang.org/cover) + +Pull requests (https://help.github.com/articles/using-pull-requests/) work +nicely as a means of contributing your changes. + License gofpdf is released under the MIT License. It is copyrighted by Kurt Jung and @@ -11,5 +11,10 @@ cat README.md | tr '\n' '\v' | sed \ -e 's/original.FPDF.library/original [FPDF](http:\/\/www.fpdf.org\/) library/g' \ -e 's/\(Effective.Go\)/[\1](https:\/\/golang.org\/doc\/effective_go.html)/g' \ -e 's/\(fpdf_test.go\)/[\1](https:\/\/github.com\/jung-kurt\/gofpdf\/blob\/master\/fpdf_test.go)/g' \ + -e 's/golint.(\(https:\/\/github\.com\/golang\/lint\))/[golint](\1)/g' \ + -e 's/go.vet.(\(https:\/\/godoc\.org\/golang\.org\/x\/tools\/cmd\/vet\))/[go vet](\1)/g' \ + -e 's/test.coverage.(\(https:\/\/blog\.golang\.org\/cover\))/[test coverage](\1)/g' \ + -e 's/Pull.requests.(\(https:\/\/help\.github\.com\/articles\/using\-pull\-requests\/\))/[Pull requests](\1)/g' \ + -e 's/Your change should\v/Your change should\v\v/g' \ | tr '\v' '\n' > 0 mv 0 README.md |