Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (24 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.29 KB

Contributing to locorda

Thank you for your interest in contributing to locorda! We welcome contributions of all kinds—bug reports, feature requests, documentation improvements, and code.

How to Contribute

  1. Fork the repository and create your branch from main.
  2. Open an issue to discuss your idea, bug, or feature request if it is significant.
  3. Write tests for any new features or bug fixes.
  4. Run dart analyze and dart test to ensure code quality and correctness.
  5. Submit a pull request with a clear description of your changes and why they are needed.

Code Style

  • Follow Dart best practices and formatting (dart format).
  • Write clear, concise documentation for public APIs.
  • Include usage examples where relevant.

Community

  • Be respectful and constructive in all interactions.
  • See the AI Policy for how we leverage generative AI.

Intellectual Property

Original Work

  • Ensure contributions are your own work or properly attributed
  • Be aware of potential patent issues, especially with CRDT algorithms
  • When referencing academic papers or existing implementations, provide proper citations

License Compatibility

By contributing, you agree that your contributions will be licensed under the MIT License.

Happy coding!