|
2 | 2 |
|
3 | 3 | Thank you for your interest in contributing! |
4 | 4 |
|
5 | | -The vision for Untold Engine is to continually shape a 3D engine that balances **clarity, performance, and creativity**. |
| 5 | +The vision for Untold Engine is to continually shape a 3D engine that is **stable, performant and developer-friendly**. |
6 | 6 | As maintainer, my focus is on **performance, testing, quality control, and API design**. |
7 | 7 | Contributors are encouraged to expand features, fix bugs, improve documentation, and enhance usability — always keeping the vision in mind. |
8 | 8 |
|
9 | 9 | --- |
10 | 10 |
|
11 | 11 | ## Maintainer Responsibilities |
12 | 12 |
|
13 | | -The Untold Engine is guided by a clear vision: **clarity, performance, and creativity**. |
14 | | -As the maintainer, my primary focus is to ensure the project stays true to this vision while remaining stable, performant, and approachable. |
| 13 | +The Untold Engine is guided by a clear vision: To be a stable, performant, and developer-friendly 3D engine that empowers creativity, removes friction, and makes game development feel effortless. |
| 14 | + |
| 15 | +## Guiding Principles |
| 16 | + |
| 17 | +To achieve this vision, we follow these principles: |
| 18 | + |
| 19 | +- The engine strives to remain stable and crash-free. |
| 20 | +- The codebase is backed by unit tests. |
| 21 | +- We profile continuously to prevent regressions (visual and performance). |
| 22 | +- The API must remain clear and user-friendly. |
| 23 | +- We always think about the developer first—removing friction so they can focus on their games. |
| 24 | + |
| 25 | +As the maintainer, my primary focus is to ensure the project stays true to this vision. |
15 | 26 |
|
16 | 27 | ### What I Focus On |
17 | 28 | - **Performance** → keeping the renderer and systems lean, efficient, and optimized for Apple hardware. |
@@ -104,4 +115,16 @@ Your guide must follow this structure: |
104 | 115 | - Make sure your code follows the [formatting guidelines](Formatting.md). |
105 | 116 |
|
106 | 117 | --- |
| 118 | + |
| 119 | +## Questions & Discussions |
| 120 | + |
| 121 | +To keep communication clear and accessible for everyone: |
| 122 | + |
| 123 | +- 💡 Use **[GitHub Discussions](https://github.com/untoldengine/UntoldEngine/discussions)** for feature proposals, ideas, or general questions. |
| 124 | +- 🐞 Use **[GitHub Issues](https://github.com/untoldengine/UntoldEngine/issues)** for bugs or concrete tasks that need tracking. |
| 125 | + |
| 126 | +This way, conversations stay organized, visible to the community, and future contributors can benefit from past discussions. |
| 127 | + |
| 128 | +--- |
| 129 | + |
107 | 130 | Thank you for contributing to the Untold Engine! Following these guidelines will ensure that your work aligns with the project's goals and provides value to users. |
0 commit comments