Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (61 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

96 lines (61 loc) · 3.67 KB

Contributing to Bitbybit

Thank you for your interest in contributing to Bitbybit! We welcome contributions from the community and appreciate your efforts to help improve the project. Please take a moment to review the following guidelines before submitting your contribution.

🐛 Found a Bug?

  • Do not open a GitHub issue if the bug is a security vulnerability.
    Instead, report it confidentially via email: info@bitbybit.dev

  • Check for existing issues before reporting a new one by searching in the Issues section

  • If no existing issue addresses the problem, open a new issue.
    Please include:

    • A clear and descriptive title
    • A detailed explanation of the issue
    • A code snippet or an executable test case that demonstrates the issue
      One of the best ways is to reproduce the bug in our TypeScript online editor and paste that code into the issue.
      Keep the example as concise and focused as possible.

🚀 Want to Contribute?

We appreciate your willingness to contribute! However, please be aware of the following:

  • Bitbybit's core algorithms are open-source under the MIT License, but they are used within proprietary tools such as our online coding editors and other software created by the company Bit by bit developers
  • Our codebase is architected to work with higher-level generators, scripts, and applications. These requirements may not be immediately obvious
  • By contributing, you acknowledge that:
    • Your contributions may be used in commercial products
    • You will not receive compensation, credit, or ownership rights
    • Any ideas or code shared may be used without obligation

🛠️ Ready to Get Started?

Before writing any code:

  • Reach out first: Email us at info@bitbybit.dev to discuss your ideas. This helps prevent wasted effort on contributions that may not align with the project's goals or architecture

  • Want a simple way to contribute?
    Help improve our documentation! Fix typos, improve content, or write new tutorials to help others use Bitbybit more effectively

🔀 Which Branch Should I Use?

  • All pull requests should target the develop branch
  • Before submitting your PR:
    • Pull the latest changes from develop
    • Resolve any merge conflicts
    • Write and run unit tests to ensure your code is stable and all tests pass

🧩 Submitting a Bug Fix?

  • Open a pull request with your patch
  • Ensure the PR clearly explains:
    • The problem it addresses
    • The proposed solution
    • The relevant issue number (if applicable)

🎨 Cosmetic Changes

Please avoid submitting changes that are purely cosmetic (e.g., formatting, whitespace) unless they are part of a larger, meaningful contribution. Cosmetic-only changes will generally not be accepted.

✨ Proposing a New Feature or Modification?

  • Start by discussing the idea with us at info@bitbybit.dev
  • Do not open a GitHub issue until the idea has been reviewed and approved
  • GitHub issues are primarily for bug tracking, not feature discussions

❓ Questions About the Code?

📚 Want to Improve Our Documentation?

  • Find our docs on GitHub
  • We use Docusaurus as our documentation framework

Thanks for helping make Bitbybit better!
— The Bit by bit developers team