Skip to content

Commit

Permalink
update README and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
Yoorkin committed Mar 21, 2024
1 parent bcb5d5c commit 3c153e8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ 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

Expand Down

0 comments on commit 3c153e8

Please sign in to comment.