SylarLong/iztro

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# 贡献指南

感谢您对本项目的兴趣!我们欢迎并鼓励社区成员的贡献。请在提交贡献之前阅读以下准则。

## 提交问题

如果您在使用本项目时遇到问题,请先查看项目的文档和已有的问题列表,以确保您的问题尚未被解决。如果您的问题是新的,请按照以下步骤提交问题:

1. 在项目的Issues页面中创建一个新的Issue,并选择`Bug Report`模板。
2. 在Issue中清晰地描述您遇到的问题,包括复现步骤和相关环境信息。
3. 如果可能,请提供相关的错误日志或截图。

## 提交建议和改进

我们欢迎社区成员提供关于项目改进的建议和想法。如果您有任何建议,请按照以下步骤提交:

1. 在项目的Issues页面中创建一个新的Issue。
2. 在Issue中清晰地描述您的建议或改进想法,包括详细的说明和背景信息。

## 提交代码贡献

如果您希望为本项目提交代码贡献,请按照以下步骤进行:

1. 在GitHub上Fork本项目的仓库。
2. 在您的本地环境中进行修改和开发。
3. 确保您的代码符合项目的编码规范和风格要求。
4. 提交Pull Request,描述清楚您的修改内容和目的。

我们会尽快审查您的Pull Request,并与您进行进一步的讨论和反馈。

## 行为准则

为了维护一个友好和包容的社区环境,我们要求所有参与者遵守以下行为准则:

- 尊重和包容他人的意见和观点。
- 避免使用攻击性、侮辱性或歧视性的语言和行为。
- 尊重项目维护者和其他贡献者的时间和努力。
- 遵守项目的代码规范和贡献指南。

如果发现任何违反行为准则的行为,请立即向项目维护者报告。

## 许可证

通过向本项目提交贡献,您同意将您的贡献内容授予项目的许可证下。

---

# Contributing Guidelines

Thank you for your interest in contributing to this project! We welcome and encourage contributions from the community. Please read the following guidelines before submitting your contributions.

## Submitting Issues

If you encounter any issues while using this project, please check the project's documentation and existing issue list to ensure that your issue has not already been addressed. If your issue is new, please follow these steps to submit it:

1. Create a new issue with `Bug Report` template on the project's Issues page.
2. Clearly describe the problem you are facing in the issue, including reproduction steps and relevant environment information.
3. If possible, provide any relevant error logs or screenshots.

## Submitting Suggestions and Improvements

We welcome suggestions and ideas for improving the project from the community. If you have any suggestions, please follow these steps to submit them:

1. Create a new issue on the project's Issues page.
2. Clearly describe your suggestion or improvement idea in the issue, including detailed explanations and background information.

## Submitting Code Contributions

If you would like to contribute code to this project, please follow these steps:

1. Fork the repository on GitHub.
2. Make your changes and developments in your local environment.
3. Ensure that your code adheres to the project's coding standards and style requirements.
4. Submit a Pull Request, clearly describing the modifications and their purpose.

We will review your Pull Request as soon as possible and engage in further discussion and feedback.

## Code of Conduct

To maintain a friendly and inclusive community environment, we require all participants to adhere to the following code of conduct:

- Respect and be considerate of others' opinions and viewpoints.
- Avoid using offensive, insulting, or discriminatory language and behavior.
- Respect the time and effort of project maintainers and other contributors.
- Adhere to the project's code standards and contribution guidelines.

If you observe any behavior that violates the code of conduct, please report it immediately to the project maintainers.

## License

By submitting contributions to this project, you agree to license your contribution content under the project's license.