CONTRIBUTING.md

Contributing

Thank you for your interest in contributing to smart-doc! For detailed guidelines on how to contribute, please review our official Contribution Guide.

Key Highlights

Before submitting a Pull Request (PR), please ensure:

• 📌 Discuss new features: Start with an Issue to align on proposed changes.
• 🧩 Single-focused PRs: Submit one fix or feature per PR to simplify reviews.
• 🌍 English comments: Use English for code comments to support international collaboration.
• ✅ Code quality: Follow the Spring Java Format style and add unit tests.
• 📄 Update documentation: Reflect your changes in relevant documentation smart-doc-group.github.io. if needed.
• 📝 Commit message guidelines: All commits must follow the Angular Commit Convention.
  • Use appropriate types: feat, fix, docs, style, refactor, test, chore, etc.
  • Keep subject and body concise, avoiding vague terms like "update code".
  • Reference related issues (e.g., Closes #1234) in the footer when applicable.

Documentation and Examples

If your contribution involves:

• 🛠️ Configuration changes:
  • Check if your PR adds or modifies configurations (e.g., new parameters, default value updates).
  • Update or add corresponding documentation in the smart-doc-group.github.io.
• 📚 New features:
  • Provide usage examples in the smart-doc-example-cn repository to demonstrate implementation.

How to Contribute

1. Fork the repository and clone it locally.
2. Create a new branch for your changes.
3. Test your modifications using smart-doc (see Quick Start).
4. Format code with mvn spring-javaformat:apply.
5. Submit a PR to the main repository.

Community Engagement

• 📰 Share your use cases or articles in the Discussions section.
• ❓ Help answer questions in the Help category.
• 💡 Propose ideas or showcase tools in Ideas or Show and tell.

Your contributions are vital to making smart-doc better for everyone. Thank you!