1- ## Contributing to NanaBox
1+ # Contributing to NanaBox
22
3- ### How to become a contributor
3+ ## How to become a contributor
44
55- Direct contributions
6- - ** Create pull requests directly.**
7- - Please send e-mails to Kenji.Mouri@outlook.com if you have any questions.
8- - You are forbidden to modify any content in any files and folders starting
9- with the "Mile." prefix, or your PR won't be merged and closed immediately.
6+ - We use a code style similar but not identical to that of Windows NT kernel
7+ drivers. You must read the code style guidelines carefully, word by word,
8+ before submitting your pull request. To maintain NanaBox's source code
9+ quality, and to respect our reviewers' time, we will not accept PRs that
10+ don't follow these guidelines.
11+ - We expect all contributions to match our existing style WITHOUT EXCEPTION.
12+ If you have any questions about our coding standards, please open an issue
13+ for discussion before submitting your pull request.
14+ - By submitting a pull request, you agree to license your contribution under
15+ the MIT license. We reserve the right to reuse and rewrite contributors' PRs
16+ as needed.
17+ - You are forbidden to modify any content in any files and folders starting
18+ with the "Mile." prefix because those implementations are shared across many
19+ projects, or your pull request will not be merged and will be closed
20+ immediately, unless you get the permission from Kenji Mouri.
21+ - It's OK to use AI/LLM tools to help you write code, but you must ensure that
22+ the final commit is written and reviewed by yourself, following our coding
23+ style and conventions. If we find that your pull request has no contribution
24+ from you, or the contribution is not reviewed by you, your pull request will
25+ not be merged and will be closed immediately.
1026- Feedback suggestions and bugs.
1127 - We use GitHub issues to track bugs and features.
1228 - For bugs and general issues please
1329 [ file a new issue] ( https://github.com/M2Team/NanaBox/issues/new ) .
1430
15- ### Code contribution guidelines
31+ ## Code contribution guidelines
1632
17- #### Prerequisites
33+ ### Prerequisites
1834
1935- Visual Studio 2022 or later.
2036 - You also need install ARM64 components (MSVC Toolchain and ATL/MFC) if you
2339 - You also need to install ARM64 components if you want to compile ARM64
2440 version of NanaBox.
2541
26- #### How to build all targets of NanaBox
42+ ### How to build all targets of NanaBox
2743
2844Run ` BuildAllTargets.bat ` in the root of the repository.
2945
30- #### How to modify or debugging NanaBox
46+ ### How to modify or debugging NanaBox
3147
3248Open ` NanaBox.slnx ` in the root of the repository.
3349
34- #### Code style and conventions
50+ ### Code style and conventions
3551
3652Read Kenji Mouri's [ MD24: The coding style for all my open-source projects] for
3753more information.
@@ -42,7 +58,7 @@ For all languages respect the [.editorconfig](https://editorconfig.org/) file
4258specified in the source tree. Many IDEs natively support this or can with a
4359plugin.
4460
45- ### Translation contribution notice
61+ #### Translation contribution notice
4662
4763All ` comment ` in ` resw ` files should be kept English for make it better to
4864maintenance in the future.
0 commit comments