-
Notifications
You must be signed in to change notification settings - Fork 138
docs: improve issue templates and add PR form #227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: improve issue templates and add PR form #227
Conversation
https://funstory-ai.github.io/BabelDOC/CONTRIBUTING/ It may be necessary to specify in the checkbox of the PR:
However, I've been thinking about changing this sentence to:
In the PR template, you can directly use the one below, I'll modify the docs later. |
@awwaawwa thanks for taking the time to review and share you feedback. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
.github/PULL_REQUEST_TEMPLATE/pr_form.yml:2
- [nitpick] The project name 'babelDoc' is inconsistently capitalized; consider changing it to 'BabelDOC' to align with other templates.
description: Submit a pull request to contribute to babelDoc
.github/PULL_REQUEST_TEMPLATE/pr_form.yml:10
- [nitpick] Inconsistent naming detected; update 'babelDoc' to 'BabelDOC' for consistency across the project.
## 👋 Thanks for contributing to **babelDoc**!
Please correct the capitalization of BabelDOC. |
Updated . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
Thank you for your contribution. According to https://funstory-ai.github.io/BabelDOC/CONTRIBUTOR_REWARD/ , you can apply for a monthly membership redemption code for Immersive Translate. |
This PR introduces improvements to the existing issue templates and adds a dedicated pull request (PR) form to streamline the contribution workflow. It ensures clarity, consistency, and professionalism across all user submissions.
Key Improvements:
✅ Enhanced bug report and feature request templates with better structure, validations, and contextual help.
➕ Introduced a PR form template to guide contributors when opening pull requests.
🏷️ Encourages better labeling and checklists to reduce review time and improve clarity.
These changes aim to make contributing to BabelDOC more intuitive and efficient, particularly as the community grows.