Thank you for considering contributing to the ztnet repository! This document outlines the guidelines and procedures for contributing code, reporting issues, and submitting pull requests.
We encourage all contributors to follow our Code of Conduct to ensure that the community is welcoming and inclusive to all.
If you encounter any issues or bugs with the ztnet repository, please report them on our GitHub issue tracker. Please include as much detail as possible, including steps to reproduce the issue and any relevant error messages.
If you would like to contribute code to the ztnet repository, please follow these guidelines:
- Fork the repository and clone it to your local machine.
- Create a new branch for your changes. The branch should be named in the following format:
feature/<description>
for new features, orbugfix/<description>
for bug fixes. - Write your code, and include relevant tests to ensure that your changes are working as expected.
- Ensure that your code follows the project's style guide.
- Commit your changes and push them to your forked repository.
- Create a pull request towards the
dev
branch of the main repository. Please include a description of your changes and any relevant information.
When submitting a pull request, please follow these guidelines:
- Ensure that your changes are based on the latest version of the
dev
branch of the main repository. - Ensure that your changes are thoroughly tested.
- Provide a clear and concise description of your changes, including any relevant information for reviewers.
- Follow the project's style guide.
Please note that all pull requests will be reviewed by the project maintainers before they are merged into the dev
branch.
Thank you for considering contributing to the ztnet repository. We appreciate your help in making this project better! If you have any questions, please don't hesitate to reach out to the project maintainers.