Welcome to contribute to ONU! Follow the steps below:
-
Fork this repository Click the "Fork" button in the upper right corner of the project page to create a fork under your GitHub account.
-
Clone the repository locally
git clone https://github.com/HeZeBang/ONU.git
-
Create a branch
git checkout -b feature/your-feature # add a feature git checkout -b bugfix/your-patch # fix a bug
-
Make changes Make changes on your local branch, ensuring compliance with the project's code standards.
-
Run tests After the changes, make sure to run the project's tests to ensure your changes haven't introduced new issues.
-
Commit changes
git add . git commit -m "Add your commit message here"
-
Push changes
git push origin feature/your-feature
-
Submit a Pull Request
On the GitHub page, select the "New Pull Request" button, choose your branch, and submit the Pull Request.
Ensure your code adheres to the project's coding standards.
| Naming Convention | Applicable Types | Example |
|---|---|---|
| Snake Case | Global variables, functions; Variables inherited from the ONU module |
global_variable |
| Upper Snake Case | Constants | CONST_VARIABLE |
| Camel Case | Local variables | myVariable |
| Pascal Case | Class names; Interface names |
MyClass |
Use clear, concise commit messages describing what your changes are. If applicable, follow the Conventional Commits specification.
Ensure your changes comply with the project's license.
ONU! is based on the MIT license.
If you have any questions or need assistance, please raise an issue on GitHub or send an email to [email protected].
Thank you for contributing to the project!