We welcome all contributions! We accept contributions through GitHub pull requests and issues. Before setting out on making any significant contribution, please file an issue or assign an issue to yourself.
- See our new Community Page
- Join our Slack Community
- Find issues and become a contributor
- Join us at one of our Fn Events or even speak at one!
- Writing Extensions
- Using Annotations
The Fn maintainers take security seriously. If you discover a security issue, please bring it to their attention right away!
Please DO NOT file a public issue, instead send your report privately to
[email protected]. Please have as the
subject [FN SECURITY BUG]: $your_title.
Security reports are greatly appreciated and we will publicly thank you for it. We currently do not offer a paid security bounty program, but are not ruling it out in the future. We do, however, offer swag.
A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it!
Check that our issues doesn't already include that problem or suggestion before submitting an issue. If you find a match, you can use the "subscribe" button to get notified on updates. Please do not leave random "+1" or "I have this too" comments, as they only clutter the discussion, and don't help resolving it. However, if you have ways to reproduce the issue or have additional information that may help resolving the issue, please leave a comment. Please do leave a "+1" thumbs up reaction on the parent comment, this greatly helps us prioritize issues!
When reporting issues, always include:
- The output of
fn version.
Also include the steps required to reproduce the problem if possible and applicable. This information will help us review and fix your issue faster. When sending lengthy log-files, consider posting them as a gist (https://gist.github.com). Don't forget to remove sensitive data from your logfiles before posting (you can replace those parts with "REDACTED").
- Get the repo you want to contribute to, for example:
$ git clone https://github.com/fnproject/fn(hint: do not clone your fork, it will break the build) - Fork the repo on GitHub, add your remote:
$ git remote add fork https://github.com/$you/fn - Fix an issue or create an issue and fix it
- Create a Pull Request that fixes the issue:
$ git push fork $your_branch-> open PR from your repo tofnproject/fn - Sign the CLA
- Once processed, our CLA bot will automatically clear the CLA check on the PR
- Good Job! Thanks for being awesome!
The coding style suggested by the Golang community is used in fn. See the style doc for details.
Please follow this style to make fn easy to review, maintain and develop.
Commit messages must start with a capitalized and short summary (max. 50 chars) written in the imperative, followed by an optional, more detailed explanatory text which is separated from the summary by an empty line. The better the commit message, the less dialogue we will need to get your PR merged!
Commit messages should follow best practices, including explaining the context of the problem and how it was solved, including in caveats or follow up changes required. They should tell the story of the change and provide readers understanding of what led to it.
Pull requests must be cleanly rebased on top of master without multiple branches mixed into the PR.
Git tip: If your PR no longer merges cleanly, use rebase master in your
feature branch to update your pull request rather than merge master.
Before you make a pull request, squash your commits into logical units of work
using git rebase -i and git push -f. A logical unit of work is a consistent
set of patches that should be reviewed together: for example, upgrading the
version of a vendored dependency and taking advantage of its now available new
feature constitute two separate units of work. Implementing a new function and
calling it in another file constitute a single logical unit of work. The very
high majority of submissions should have a single commit, so if in doubt: squash
down to one.
Include an issue reference like Closes #XXXX or Fixes #XXXX in commits that
close an issue. Including references automatically closes the issue on a merge.
When updating your PR with new commits, keep in mind that reviewers may only be notified when you comment (not on every commit), please don't hesitate to ping us on the PR when you are ready for another look, we will try to take a look as soon as we can.
When creating a Pull Request, make sure that you also update the documentation accordingly.
Most of the time, when making some behavior more explicit or adding a feature, documentation update is necessary.
You will either update a file inside docs/ or create one. Prefer the former over the latter. If you are unsure, do not hesitate to open a PR with a comment asking for suggestions on how to address the documentation part or ask in slack.