CONTRIBUTING.md

First steps

Thank you for getting involved! Before you start, please familiarize yourself with the documentation.

Please follow our Code of Conduct when interacting with this project.

If you want to support our development:

• Add a GitHub Star to the project
• Share our projects on social media
• Join the Confidential Computing Discord

EdgelessDB is licensed under GPLv2. When contributing, you also need to agree to our Contributor License Agreement.

Development guidelines

Adhere to the style and best practices described in Effective Go. Read Common Review Comments for further information.

Pull request process

Submissions should remain focused in scope and avoid containing unrelated commits. For pull requests, we employ the following workflow:

1. Fork the repository to your own GitHub account
2. Create a branch locally with a descriptive name
3. Commit changes to the branch
4. Write your code according to our development guidelines
5. Push changes to your fork
6. Clean up your commit history
7. Open a PR in our repository and summarize the changes in the description

Reporting issues and bugs, asking questions

This project uses the GitHub issue tracker. Please check the existing issues before submitting to avoid duplicates.

Please report any security issue via a private GitHub vulnerability report or write to [email protected].

Your bug report should cover the following points:

• A quick summary and/or background of the issue
• Steps to reproduce (be specific, e.g., provide sample code)
• What you expected would happen
• What actually happens
• Further notes:
  • Thoughts on possible causes
  • Tested workarounds or fixes

Major changes and feature requests

You should discuss larger changes and feature requests with the maintainers. Please open an issue describing your plans.