Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (21 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.73 KB

Contributing to PeerChat

Thank you for your interest in contributing to PeerChat! We are excited to build the future of decentralized communication together.

🤖 AI Contribution Policy

We welcome the use of AI tools (like Claude Code, Cursor, Gemini, etc.) to assist in your contributions. However, to maintain the high quality and security of PeerChat, we ask that you follow these guidelines:

  1. Human-in-the-Loop: You are responsible for every line of code you submit. You must understand the logic, security implications, and architecture of any AI-suggested changes.
  2. Transparency: If a significant portion of your PR was generated by AI, please disclose this in the PR description.
  3. Quality First: Do not submit "low-effort" AI generated code. Ensure all code follows our project's style and passes all tests.

🚀 Getting Started

  1. Fork the repo and create your branch from main.
  2. Setup the environment: Ensure you have Flutter installed and run flutter pub get.
  3. Make your changes: Implement your feature or fix.
  4. Test: Run flutter test to ensure no regressions.
  5. Submit a PR: Detailed instructions below.

🛠️ Code Style

  • Follow the official Flutter style guide.
  • Use dart format before committing.
  • Ensure all new features are accompanied by tests.

🛡️ Security First

PeerChat is a privacy app. Any contribution involving cryptography or networking must be peer-reviewed with extreme care. Never include hardcoded keys or reduce encryption standards.

💬 Community

Join our Discussions if you have questions or want to propose a major change before starting work.