Contributing Guide for OpenSCA-cli

中文 | English

We warmly welcome anyone who wants to provide improvement suggestions, submit bug reports, or submit new feature pull requests for OpenSCA-cli. This guide will help you understand how to make contributions to OpenSCA-cli.

Reporting Issues

If you encounter issues while using OpenSCA-cli, please submit a bug report on the GitHub Issues page. When submitting a bug report, please describe the issue in as much detail as possible, including:

• What you were doing when the issue occurred
• What you expected to see
• What actually happened
• Error messages (if any)
• Your operating system and version
• Your version of OpenSCA-cli

Please provide the steps to reproduce the issue, if possible. This will help us understand and solve the problem more quickly.

Submitting Improvement Suggestions

If you have any suggestions for improving OpenSCA-cli, you are also welcome to submit them on the Issues page. When you submit a suggestion, please explain your suggestion in detail and why it would improve OpenSCA-cli.

Submitting Pull Requests

If you want to add new features to OpenSCA-cli or fix bugs, you can fork the project, make changes on your branch, and then submit a pull request.

Before submitting your pull request, please make sure your code meets the following requirements:

• Complies with the project's coding style
• Has sufficient tests
• Updates relevant documentation (if any)
• Has no merge conflicts
• When submitting your pull request, please explain in detail the changes you made and why you made them. If your pull request is to solve an issue, please refer to the issue in your pull request.

Our maintainers will review your pull request as soon as possible. If everything meets the requirements, we will merge your code, and you will see your name in the list of project contributors.

Contributor Code of Conduct

We hope that the OpenSCA community is an open and welcoming environment. Therefore, we require all contributors to adhere to our code of conduct. Please read and understand these guidelines before participating in the project.

Please remember, your contribution directly reflects the value and influence of the OpenSCA-cli community, and we deeply appreciate your contributions.