Contributions are welcome via GitHub pull requests. This document outlines the process to help get your contribution accepted.
The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO. Contributors must sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.
This is my commit message
Signed-off-by: Random J Developer <[email protected]>
See git help commit:
-s, --signoff
Add Signed-off-by line by the committer at the end of the commit log
message. The meaning of a signoff depends on the project, but it typically
certifies that committer has the rights to submit this work under the same
license and agrees to a Developer Certificate of Origin (see
http://developercertificate.org/ for more information).
- Fork this repository, develop, and test your changes
- Remember to sign off your commits as described above
- Submit a pull request
NOTE: In order to make testing and merging of PRs easier, please submit changes to multiple components in separate PRs.
- Only solve one problem at a time
- Write clean code (See Effective Go)
- Write testcases for your code changes
- Include clear documentation especially via (GoDoc comments)
- Ensure the PR is linked to an issue. If your solution has a design element, please review that in the issue discussion before working on the PR
The package version should follow semver.
Currently, the package is under active development and not ready for general use. During this period it will remain below 1.0.0
This repo supports the pre-commit framework. Functionality may be incomplete, and you are welcome to file an issue or open a PR
A Taskfile is provided along with a set of .taskfiles for use with the go-task utility. Full capabilities may be incomplete, but the intention is to help with common tasks like regenerating ent schemas or protobufs