Feedback
Regarding Q&A, please follow the process below:
- For content available in the
Wiki, please take the time to read the documentation, and do not raise anIssue. - Duplicate
Issueswill be deleted. Please first search your question inIssuesto confirm it hasn't been raised before creating a newIssue. - If you encounter an error and are certain it's a
Bug, please report it as aBug or PRfollowing theIssuetemplate. - For consultations and discussions, please join the WeChat group for communication.
Why Write This Document
The purpose of compiling this document is to reduce some confusion for newcomers and beginners. Please review it carefully if you have any questions. Of course, in appreciation of our effort in compiling the document, if you like smart-doc, please also recommend it to your colleagues or friends. Good things should be shared with everyone.
smart-doc Test Case Feedback
Some bugs have emerged. It's hard for the official team to replicate issues reported with just a few lines of code pasted in a simple issue. In such cases, it's necessary to provide a code example that can replicate the issue. Below is how to provide test cases to the official team.
Single Module Test Case
If the issue can be replicated in a single module, the steps for submitting a test case are as follows:
Forkthe smart-doc-example-cn project into your personal repository;- Modify the
forkedcode to add a test case. Then, on the project'sGitHub, there will be a【Sync fork】option. Choose to submit a PR to us. The official team will also merge the test case to test the problem.
Multi-Module Project Test Case Feedback
If the issue can only be replicated in a multi-module context, the steps for submitting a test case are as follows:
Forkthe spring-boot-maven-multiple-module project into your personal repository;- Modify the
forkedcode to add a test case. Then, on the project'sGitee, there will be a【Pull Request】option. Choose to submit a PR to us. The official team will also merge the test case to test the problem.