If you are looking for something to work on, or need some assistance in debugging a problem or working out a fix to an issue, please visit our Slack channels and will gladly help. To join Amalgam8 Slack, please use auto-invite.
If you are a user and you find a bug, please submit an issue to the appropriate sub-project. If unsure, please consult with us on the Slack users channel. Please try to provide sufficient information for someone else to reproduce the issue. One of the project's maintainers should respond to your issue within 24 hours. If not, please bump the issue and request that it be reviewed.
Review the issues list for a sub-project and find something that interests you. Usually there will be a comment in the issue that indicates whether someone is already assigned to the issue. If no one has already taken it, then add a comment assigning the issue to yourself. You could also join the conversation on the Slack developer channel.
We are using GitHub Forking process to manage code contributions. If you are unfamiliar, please review that link (or this one) before proceeding.
When you need feedback or help, or you think the branch is ready for merging, open a pull request. Please make sure you have first successfully built and tested the code beforehand.
For sub-projects using Go™ please follow the best practices. You must use the default Go formatting guidelines for your source code and run static analysis tools before submitting a pull request. These tasks can be run in an automated fashion by invoking
make precommitYou can install a git-hook into the local .git/hooks/ directory, as a
pre-commit or pre-push hook.
Whenever adding/removing/updating dependencies (make depend.update), make sure to do so in a single, isolated commit, that touches only glide.* and vendor/* files.
This avoids polluting/obfuscating other commits in the same pull request, and keeps it easy to review.
Note: Each source file must include a license header for the Apache Software License 2.0. A template of that header can be found here.
We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. Contributions require sign-off. The sign-off is a simple line at the end of the commit message for the patch or pull request. It certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.
If you can certify the Developer's Certificate of Origin 1.1 (DCO) then you just add a Signed-off-by line, which indicates that the you accept the DCO
Signed-off-by: Jane Doe <[email protected]>
When committing using the command line you can sign off using the --signoff or -s flag.
This adds a Signed-off-by line by the committer at the end of the commit log message.
git commit -s -m "Commit message"