Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (65 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

88 lines (65 loc) · 2.37 KB

Contributing Guide

Thank you for your interest in contributing. ECHO is an open source project. If you are interested in making it better, there are many ways you can contribute. For example, you can:

  • Submit a bug report
  • Suggest a new feature
  • Provide feedback by commenting on feature requests/proposals
  • Propose a patch by submitting a pull request
  • Suggest or submit documentation improvements
  • Review outstanding pull requests
  • Answer questions from other users
  • Share the software with other users who are interested
  • Teach others to use the software

We're particularly interested in these contributions:

  • Security improvements
  • Privacy enhancements
  • Reliability enhancements
  • Public sector application experience
  • Backend development
  • Frontend development

Types of Contributions

We categorize contributions into three main types:

1. Security & Privacy Improvements

  • These are our highest priority
  • Will be reviewed and merged quickly if they verifiably improve security/privacy
  • Should include clear documentation of the improvement

2. Bug Fixes & Core Improvements

  • Fixes for existing functionality
  • Performance improvements
  • Documentation improvements
  • Will be reviewed based on impact and alignment with project goals

3. New Features

  • Must align with project roadmap (coming soon)
  • Will be reviewed by both technical team and advisory board
  • Should include documentation and tests

Contribution Guidelines

Code Style

  • Follow existing code style
  • Use meaningful variable/function names
  • Include comments for complex logic

Documentation

  • Update relevant documentation
  • Add inline comments for complex code
  • Include examples where appropriate

Testing

  • Add tests for new features
  • Ensure existing tests pass
  • Document test cases

Review Process

  1. Initial review by maintainers
  2. Feedback and discussion
  3. Revisions if needed
  4. Final review and merge

Community Guidelines

  • Be respectful and constructive
  • Follow our code of conduct
  • Help others when possible
  • Ask questions if unclear

Getting Help

  • Create an issue for bugs
  • Email sameer@dembrane.com for security issues or general guidance
  • Discuss major changes in issues before coding
  • Reach out to maintainers if stuck

License

By contributing, you agree that your contributions will be licensed under our license.

Thanks! ❤️

Dembrane Team