Skip to content

Commit 4b14e73

Browse files
matas-bitbybit-devmatas-bitbybit-dev
authored
Merge pull request #77 from bitbybit-dev/develop
v0.20.4
2 parents 5a4261e + e0e4161 commit 4b14e73

File tree

486 files changed

+250159
-460
lines changed

Some content is hidden

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

486 files changed

+250159
-460
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
info@bitbybit.dev.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎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: [info@bitbybit.dev](mailto:info@bitbybit.dev)
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 [info@bitbybit.dev](mailto: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
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 [info@bitbybit.dev](mailto:info@bitbybit.dev)
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

‎README.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
1-
## Bit By Bit Developers monorepo
1+
# Bitbybit Monorepo
22

3-
Visit [bitbybit.dev](https://bitbybit.dev) to use our full cloud platform.
3+
<img src="https://app.bitbybit.dev/assets/git-cover.png" alt="Picture showing bitbybit.dev platform">
4+
5+
This git repo contains multiple bitbybit packages and contains code for 3D algorithms of Bit By Bit Developers platform which are open-sourced under MIT license.
6+
7+
# [FULL PLATFORM AT BITBYBIT.DEV](https://bitbybit.dev)
8+
# [LEARN BITBYBIT](https://learn.bitbybit.dev)
9+
10+
## SUPPORT THE MISSION
411
Best way to support us - [Silver or Gold plan subscription](https://bitbybit.dev/auth/pick-plan)
512
Buy unique products from our [Crafts shop](https://crafts.bitbybit.dev) all designed with Bitbybit algorithms
613
Check out [3D Bits app for Shopify](https://apps.shopify.com/3d-bits-1) also used in our Crafts shop
714

8-
<img src="https://app.bitbybit.dev/assets/git-cover.png" alt="Picture showing bitbybit.dev platform">
15+
Your contributions allow this project to exist.
916

10-
This git repo contains multiple bitbybit packages and contains code for 3D algorithms of Bit By Bit Developers platform which are open-sourced under MIT license.
17+
## HISTORY
1118

1219
This library was previously UI dependant and was heaviy intertwined with BabylonJS game engine. It is now decoupled from our editors to ensure protection of our corporate identity and cloud services. BabylonJS layer is now also separated into special package @bitbybit-dev/babylonjs - this will cause the breaking change in v0.18.0. If you are using the version prior to v0.18.0 and depend on the @bitbybit-dev/core package, please consider updating to use @bitbybit-dev/babylonjs NPM package. @bitbybit-dev/core is now game engine independent layer.
1320

‎docs/.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

0 commit comments

Comments
 (0)