§ Contribution Guide
We welcome and encourage community contributions to Flynn.
Please familiarize yourself with the Contribution Guidelines and Project Roadmap before contributing.
There are many ways to help Flynn besides contributing code:
- Fix bugs or file issues
- Improve the documentation
§ Contributing Code
Unless you are fixing a known bug, we strongly recommend discussing it with the core team via a GitHub issue, IRC, or email before getting started to ensure your work is consistent with Flynn’s roadmap and architecture.
All contributions are made via pull request. Note that all patches from all contributors get reviewed. After a pull request is made other contributors will offer feedback, and if the patch passes review a maintainer will accept it with a comment. When pull requests fail testing, authors are expected to update their pull requests to address the failures until the tests pass and the pull request merges successfully.
At least one review from a maintainer is required for all patches (even patches from maintainers).
Reviewers should leave a “LGTM” comment once they are satisfied with the patch. If the patch was submitted by a maintainer with write access, the pull request should be merged by the submitter after review.
§ Code Style
Please follow these guidelines when formatting source code:
- Go code should match the output of
- Shell scripts should adhere to the Google Shell Style guide
§ Developer’s Certificate of Origin
All contributions must include acceptance of the DCO:
Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 660 York Street, Suite 102, San Francisco, CA 94110 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 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.
To accept the DCO, simply add this line to each commit message with your name and email address (
git commit -s will do this for you):
Signed-off-by: Jane Example <firstname.lastname@example.org>
For legal reasons, no anonymous or pseudonymous contributions are accepted (contact us if this is an issue).
§ Pull request procedure
To make a pull request, you will need a GitHub account; if you are unclear on this process, see GitHub’s documentation on forking and pull requests. Pull requests should be targeted at the
master branch. Before creating a pull request, go through this checklist:
- Create a feature branch off of
masterso that changes do not get mixed up.
- Rebase your local changes against the
- Run the full project test suite with the
go test ./...(or equivalent) command and confirm that it passes.
gofmt -s(if the project is written in Go).
- Accept the Developer’s Certificate of Origin on all commits (see above).
- Ensure that each commit has a subsystem prefix (ex:
Pull requests will be treated as “review requests,” and maintainers will give feedback on the style and substance of the patch.
Normally, all pull requests must include tests that test your change. Occasionally, a change will be very difficult to test for. In those cases, please include a note in your commit message explaining why.
We use the #flynn IRC channel on Freenode. You are welcome to drop in and ask questions, discuss bugs, etc. It is logged on BotBot.me and you can connect using webchat if you do not have an IRC client.
Whether you are a regular contributor or a newcomer, we care about making this community a safe place for you and we’ve got your back.
- We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.
- Please avoid using nicknames that might detract from a friendly, safe and welcoming environment for all.
- Be kind and courteous. There is no need to be mean or rude.
- We will exclude you from interaction if you insult, demean or harass anyone. In particular, we do not tolerate behavior that excludes people in socially marginalized groups.
- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or a member of the Flynn core team immediately.
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.
We welcome discussion about creating a welcoming, safe, and productive environment for the community. If you have any questions, feedback, or concerns please let us know.