From 26ca2aaa78e7712ddaf45f182396dc941fea8b3f Mon Sep 17 00:00:00 2001 From: Yorkin Date: Thu, 21 Mar 2024 15:00:56 +0800 Subject: [PATCH] update README and CONTRIBUTING (#94) * update README and CONTRIBUTING * add warning emoji --------- Co-authored-by: Li Junchen --- CONTRIBUTING.md | 7 +++++++ README.md | 6 ++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0a656a20..c4b5933f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,6 +46,13 @@ Now it's time to make your changes to the codebase. Whether it's fixing a bug, adding a new feature, or improving documentation, your contributions are welcome. Ensure that your changes are clear and understandable to others who will review your code. +Currently there are some simple restrictions for naming convention and code formatting: + +- All function names, method names, and variables should use `snake_case`, while all type names should use `PascalCase`. +- The code formatting should align with the result of moonfmt as much as possible. +- For public functions and types, tests and documentation should be provided. + + ## Step 3: Test your change After making your changes, it's important to test them to ensure they work as expected and do not introduce new issues. Run the following commands to test your changes: diff --git a/README.md b/README.md index 4edeca6d4..ef4d24bea 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,12 @@ moonbitlang/core is the standard library of the [MoonBit language](https://www.m ## Current status -It is experimental and under active development. The API is subject to change. +It is experimental and under active development. At this early stage, our primary focus is on enhancing the functionality of `moonbitlang/core`. + +⚠️**The API is subject to change.** In future, we plan to reorganize the API to ensure a consistent style. ## Contributing We are actively developing moonbitlang/core and appreciate your help! -To contribute, please read the contribution guidelines at [CONTRIBUTING.md](./CONTRIBUTING.md). \ No newline at end of file +To contribute, please read the contribution guidelines at [CONTRIBUTING.md](./CONTRIBUTING.md).