Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.21 KB

File metadata and controls

27 lines (20 loc) · 1.21 KB

Contributing to DeepBrain AI Docs 🤝

🙌 Thank you for your interest in contributing!
This guide explains how you can get involved and make meaningful contributions.

Note: If you are not an internal member of DeepBrain AI, please follow the steps below when contributing.

🔧 Pull Request Guidelines

  • Please open an issue first before submitting any pull requests.
  • Describe the purpose of your PR clearly (e.g., bug fix, feature addition, documentation).
  • Reference related issues in your PR description (e.g., Closes #12).
  • Include tests where applicable.
  • Make sure your code builds and passes tests before submitting.

✅ Commit Style

We leave commit message style up to you, but please follow modern, meaningful conventions such as:

  • Conventional Commits (e.g., feat:, fix:, docs:)
  • Clear, concise summaries (no “misc” or “stuff”)
  • Use English for commits

This helps maintainers and contributors understand changes at a glance.

💬 Communication

  • For questions, open a GitHub Discussion or reach out via issues.
  • Be respectful and constructive when providing feedback.

We appreciate every contribution, big or small, and are excited to see what you build!