Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.57 KB

Note: by contributing code to the FalkorDB project in any form, including sending a pull request via Github, a code fragment or patch via private email or public discussion groups, you agree to release your code under the terms of the SSPL license that you can find in the LICENSE.txt file included in the FalkorDB source distribution. You will include SSPL license in the COPYING file within each source file that you contribute.

IMPORTANT: HOW TO USE FalkorDB GITHUB ISSUES

Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature requests. Everything else belongs to the FalkorDB Discussions.

PLEASE DO NOT POST GENERAL QUESTIONS that are not about bugs or suspected bugs in the Github issues system. We'll be very happy to help you and provide all the support in the Discussions.

Issues and pull requests for documentation belong on the FalkorDB documentation repository:

https://github.com/FalkorDB/falkordb.github.io

If you are reporting a security bug or vulnerability, see SECURITY.md.

How to provide a patch for a new feature

Use the following procedure to submit a patch:

a. Fork FalkorDB on github ( https://docs.github.com/en/github/getting-started-with-github/fork-a-repo )
b. Create a topic branch (git checkout -b my_branch)
c. Push to your branch (git push origin my_branch)
d. Initiate a pull request on github ( https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request )
e. Done :)

Thanks!