Contributing Guidelines for UTMStack
These guidelines are intended to help you contribute to the UTMStack repository in a way that is both helpful and productive.
How to Contribute
- Fork the UTMStack repository.
- Clone your forked repository to your local machine.
- Create a new branch for your changes.
- Make your changes and commit them to your branch.
- Push your branch to your forked repository.
- Open a pull request against the upstream UTMStack repository.
- Respond to any feedback from maintainers and make changes as needed.
- Once your pull request is approved, it will be merged into the upstream UTMStack repository.
Code Style
- Please follow the PEP 8 style guide for Python code.
- Please follow the Golang style guide for Golang code.
- Please follow the Java style guide for Java code.
- Please follow the TypeScript style guide for TypeScript code.
- Please use descriptive variable and function names.
- Please add comments to your code to explain what it does and why.
- Please use consistent formatting throughout your code.
Testing
- Please add unit tests for your changes.
- Please make sure that your changes do not break any existing tests.
Documentation
- Please update the documentation to reflect your changes.
- Please add new documentation for any new features or functionality that you add.
Other Guidelines
- Please be respectful of other contributors.
- Please be constructive in your feedback.
- Please be patient. It may take some time for your pull request to be reviewed and merged.
Thank you for your contributions to the UTMStack repository!