Skip to content

Commit 6496f37

Browse files
update to docs with new content, migrated articles, added full API definition, blog post migrations, added Contributing.md file
1 parent 0d11aaf commit 6496f37

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+44549
-45
lines changed

CONTRIBUTING.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Contributing to Bitbybit
2+
3+
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.
4+
5+
---
6+
7+
## 🐛 Found a Bug?
8+
9+
- **Do not open a GitHub issue if the bug is a security vulnerability.**
10+
Instead, report it confidentially via email: [[email protected]](mailto:[email protected])
11+
12+
- **Check for existing issues** before reporting a new one by searching in the [Issues section](https://github.com/bitbybit-dev/bitbybit/issues)
13+
14+
- If no existing issue addresses the problem, [open a new issue](https://github.com/bitbybit-dev/bitbybit/issues/new).
15+
Please include:
16+
- A clear and descriptive title
17+
- A detailed explanation of the issue
18+
- A code snippet or an executable test case that demonstrates the issue
19+
One of the best ways is to reproduce the bug in our [TypeScript online editor](https://bitbybit.dev/app?editor=typescript) and paste that code into the issue.
20+
Keep the example as concise and focused as possible.
21+
22+
---
23+
24+
## 🚀 Want to Contribute?
25+
26+
We appreciate your willingness to contribute! However, please be aware of the following:
27+
28+
- 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**
29+
- Our codebase is architected to work with higher-level generators, scripts, and applications. These requirements may not be immediately obvious
30+
- **By contributing, you acknowledge** that:
31+
- Your contributions may be used in commercial products
32+
- You will **not** receive compensation, credit, or ownership rights
33+
- Any ideas or code shared may be used without obligation
34+
35+
---
36+
37+
## 🛠️ Ready to Get Started?
38+
39+
Before writing any code:
40+
41+
- **Reach out first**: Email us at [[email protected]](mailto:[email protected]) to discuss your ideas. This helps prevent wasted effort on contributions that may not align with the project's goals or architecture
42+
43+
- Want a simple way to contribute?
44+
Help improve our **documentation**! Fix typos, improve content, or write new tutorials to help others use Bitbybit more effectively
45+
46+
---
47+
48+
## 🔀 Which Branch Should I Use?
49+
50+
- All pull requests should target the `develop` branch
51+
- Before submitting your PR:
52+
- Pull the latest changes from `develop`
53+
- Resolve any merge conflicts
54+
- Write and run **unit tests** to ensure your code is stable and all tests pass
55+
56+
---
57+
58+
## 🧩 Submitting a Bug Fix?
59+
60+
- Open a pull request with your patch
61+
- Ensure the PR clearly explains:
62+
- The problem it addresses
63+
- The proposed solution
64+
- The relevant issue number (if applicable)
65+
66+
---
67+
68+
## 🎨 Cosmetic Changes
69+
70+
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.
71+
72+
---
73+
74+
## ✨ Proposing a New Feature or Modification?
75+
76+
- Start by discussing the idea with us at [[email protected]](mailto:[email protected])
77+
- Do **not** open a GitHub issue until the idea has been reviewed and approved
78+
- GitHub issues are primarily for **bug tracking**, not feature discussions
79+
80+
---
81+
82+
## ❓ Questions About the Code?
83+
84+
- Join our [Discord community](https://discord.gg/GSe3VMe) to ask questions or get help using Bitbybit
85+
86+
---
87+
88+
## 📚 Want to Improve Our Documentation?
89+
90+
- Find our docs [on GitHub](https://github.com/bitbybit-dev/bitbybit/tree/master/docs)
91+
- We use **Docusaurus** as our documentation framework
92+
93+
---
94+
95+
Thanks for helping make Bitbybit better!
96+
— The Bit by bit developers team

0 commit comments

Comments
 (0)