Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.52 KB

File metadata and controls

45 lines (29 loc) · 1.52 KB

Contributing to Litebase

Thank you for your interest in contributing to Litebase! We welcome contributions from everyone and appreciate your help in making the project better.

How to Contribute

💬 Start with a Discussion

Before starting work on a major change, please open a discussion in our Litebase Discussions. This helps align ideas early and ensures your effort fits within project goals.

🐛 Report Bugs

If you find a bug, open an issue in the repository. Include clear steps to reproduce the problem, your environment details, and any relevant logs or screenshots.

🔧 Submit a Pull Request

If you’re submitting code:

  1. Make sure your changes are tested and follow the existing code style.
  2. Reference any related issues or discussions in your PR description.
  3. Keep commits clear and focused.
  4. Be available for feedback and collaborate in good faith during review.

🧪 Testing and Code Style

  • Add or update tests where applicable.
  • Follow the language’s conventions used in the repository (e.g. go fmt, eslint, pint, etc.).
  • Avoid introducing dependencies unless necessary.

💡 Other Contributions

We also welcome:

  • Improvements to documentation and examples
  • Enhancements to test coverage
  • Translations, tutorials, or community guides
  • Feedback on design and developer experience

🤝 Communication

Be respectful and constructive. All contributors are expected to follow the Litebase Code of Conduct.