Skip to content

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

Merged

Conversation

PravinKamble123
Copy link
Contributor

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.

@awwaawwa
Copy link
Member

awwaawwa commented Apr 8, 2025

https://funstory-ai.github.io/BabelDOC/CONTRIBUTING/

It may be necessary to specify in the checkbox of the PR:

Due to the current high rate of code changes, this project only accepts small PRs. If you would like to suggest a change and you include a patch as a proof-of-concept, that would be great. However, please do not be offended if we rewrite your patch from scratch.

However, I've been thinking about changing this sentence to:

Due to limited maintainer resources, this project only accepts small pull requests. Suggestions for changes accompanied by a proof-of-concept patch are highly appreciated. However, please understand that your patch may be rewritten from scratch if necessary.

In the PR template, you can directly use the one below, I'll modify the docs later.

@PravinKamble123
Copy link
Contributor Author

PravinKamble123 commented Apr 9, 2025

@awwaawwa thanks for taking the time to review and share you feedback.
Updated the PR template to include the contribution policy note as suggested. Let me know if anything else is needed! 🙌

@awwaawwa awwaawwa requested a review from Copilot April 9, 2025 12:20
Copy link

@Copilot Copilot AI left a 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**!

@awwaawwa
Copy link
Member

awwaawwa commented Apr 9, 2025

Please correct the capitalization of BabelDOC.

@PravinKamble123
Copy link
Contributor Author

Please correct the capitalization of BabelDOC.

Updated .

@awwaawwa awwaawwa requested a review from Copilot April 9, 2025 13:07
Copy link

@Copilot Copilot AI left a 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.

@awwaawwa
Copy link
Member

awwaawwa commented Apr 9, 2025

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.

@awwaawwa awwaawwa merged commit f9eaefa into funstory-ai:main Apr 9, 2025
3 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants