Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

64 lines (48 loc) · 3.02 KB
Raw

Contributing

Contributions are welcome!

  1. Fork it (https://github.com/LeadPipeSoftware/medikit/fork)
  2. Create your feature or bug branch (git checkout -b feature/foobar)
  3. Commit your changes (git commit -am 'Add some foobar')
  4. Push to the branch (git push origin feature/foobar)
  5. Create a new Pull Request

Before spending lots of time on something, please ask for feedback on your idea first!

Please search through the existing issues and pull requests before adding something new to avoid duplicating efforts and conversations.

Non-Code Contributions

This project welcomes non-code contributions, too! The following types of contributions are welcome:

  • Ideas: participate in an issue thread or start your own to have your voice heard.
  • Writing: contribute your expertise in an area by helping expand the included docs.
  • Copy editing: fix typos, clarify language, and improve the quality of the docs.
  • Formatting: help keep docs easy to read with consistent formatting.

Code Style

Fortunately, with golang there are fewer style arguments. Run gofmt and you'll probably be fine. Otherwise, please have a look at Google's own Code Review Comments to get a good idea of the kinds of things reviewers will be looking at.

Rules

There are a few basic ground-rules for contributors:

  1. Pull requests are required for all contributions to solicit feedback, but left to the discretion of the contributor.
  2. No --force pushes or modifying the Git history in any way.
  3. feature or bug branches should be used for ongoing work.

Releases

Declaring formal releases remains the prerogative of the project maintainer.

Changes to This Arrangement

This arrangement is subject to review and modification at the project maintainer's discretion.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.