Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.83 KB

Contributing

Checkout our Development guide for more information on how to get started developing Flipt.

What To Work On

Check out our public roadmap to see what we're working on and where you can help.

Not sure how to get started? You can:

Issues

Let us know how we can help!

  • Include any stack traces with your error
  • List versions you are using: Flipt, Go, OS, etc.
  • List the contents of your Flipt configuration file. (ex: default.yml)

Code

It's always best to open a dialogue before investing a lot of time into a fix or new functionality.

Functionality must meet the design goals and vision for the project to be accepted; we would be happy to discuss how your idea can best fit into the future of Flipt.

Join our Discord to chat with the team about any feature ideas or open a Discussion here on GitHub.

Conventional Commits

We use Conventional Commits for commit messages. Please adhere to this specification when contributing.

Testing

New functionality must have accompanying tests. We aim to keep the total test coverage of the project above 80%.

Legal

By submitting a Pull Request, you disavow any rights or claims to any changes submitted to the Flipt project and assign the copyright of those changes to Flipt Software Inc.

If you cannot or do not want to reassign those rights (your employment contract for your employer may not allow this), you should not submit a PR. Open an issue and someone else can do the work.

This is a legal way of saying "If you submit a PR to us, that code becomes ours". 99.9% of the time that's what you intend anyways; we hope it doesn't scare you away from contributing.