diff options
author | Kurt Jung <kurt.w.jung@gmail.com> | 2015-07-12 12:56:16 -0400 |
---|---|---|
committer | Kurt Jung <kurt.w.jung@gmail.com> | 2015-07-12 12:56:16 -0400 |
commit | e0ce0b54dfdf5df24df8d59374f2e579fa724c4f (patch) | |
tree | 0f02808719ea338cea57df0053f29cb4e9d624a7 /README.md | |
parent | 0fc3e570463d3cbe35071b0dc71e3f63c074f7d1 (diff) |
Add section on contributing changes to gofpdf
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 19 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 |