From 7b4438c9055b60c253c682c8c43bbc0eccbb720f Mon Sep 17 00:00:00 2001 From: Dhairya Gothi <142989448+dhairyagothi@users.noreply.github.com> Date: Sat, 28 Sep 2024 01:52:01 +0530 Subject: [PATCH] Update pull_request_template.md --- .github/pull_request_template.md | 94 ++++++++++++++------------------ 1 file changed, 42 insertions(+), 52 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fa8b14f..14c9515 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,80 +1,70 @@ -## Related Issue - -[Cite any related issue(s) this pull request addresses. If none, simply state "None”] -write issue no. here +# Pull Request Template for GSoC 2024 -## Email id used to regsiter for VSoc'24 +## Related Issue +[Please list any related issue numbers that this pull request resolves. If none, state "None"] -## Description +closes: -[Please include a brief description of the changes or features added] -## Type of PR -- [ ] Bug fix -- [ ] Feature enhancement -- [ ] Documentation update -- [ ] Security enhancement -- [ ] Other (specify): _______________ +## Description of Changes +[Provide a concise description of the changes introduced by this PR, detailing what’s been added, modified, or fixed.] -check in issue by entering [X] in boxes +## Type of Pull Request -## Screenshots / Videos (if applicable) +- [ ] Bug Fix +- [ ] New Feature +- [ ] Performance Improvement +- [ ] Documentation Update +- [ ] Code Refactoring +- [ ] Security Enhancement +- [ ] Other (Specify): _______________ -[Attach any relevant screenshots or videos demonstrating the changes] +(Please check relevant boxes by entering an "X" inside them) -## Checklist -- [ ] I have performed a self-review of my code. -- [ ] I have read and followed the Contribution Guidelines. -- [ ] I have tested the changes thoroughly before submitting this pull request. -- [ ] I have provided relevant issue numbers, screenshots, and videos after making the changes. -- [ ] I have commented my code, particularly in hard-to-understand areas. -- [ ] I have followed the code style guidelines of this project. -- [ ] I have checked for any existing open issues that my pull request may address. -- [ ] I have ensured that my changes do not break any existing functionality. -- [ ] Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently. -- [ ] I have read the resources for guidance listed below. -- [ ] I have followed security best practices in my code changes. +## Screenshots / Demo (if applicable) -check in issue by entering [X] in boxes -## Additional Context +[Include any screenshots, GIFs, or videos that demonstrate the change or feature, if available.] -[Include any additional information or context that might be helpful for reviewers.] +## Checklist for Contributor +use'X' in [ ] to check it . +- [ ] I have reviewed my code before submission. +- [ ] I have read and followed the project's Contribution Guidelines. +- [ ] I have tested the code thoroughly. +- [ ] I have attached related issue numbers, screenshots, or videos (if applicable). +- [ ] I have added comments to my code where necessary for clarity. +- [ ] I have checked the existing code base and my changes do not introduce any breaking changes. +- [ ] My PR addresses only one issue; I have created separate PRs for other issues. +- [ ] I have ensured that the PR does not include unrelated files. +- [ ] I am mindful of the project's coding standards and best practices. +## Additional Information +[Include any additional context or relevant information that may help in reviewing this PR.] -## Contribution Guidelines +## Contribution Guidelines Reminder -Thank you for considering contributing to our project! To ensure smooth collaboration and effective contribution management, please adhere to the following guidelines: +Thank you for contributing to our project! Please ensure you follow the guidelines below: -### Issue Creation -1. **Limit on Issues:** - - Each contributor is allowed to create a maximum of **4 issues per day**. This helps us manage and address issues efficiently. ### Contribution Levels -2. **Basic Contributions:** - - This project is primarily focused on documentation. Most of the setup has been completed, so contributors will generally need to work on basic code tasks, such as writing tests. - - For these tasks, issues will be assigned the **Easy** label. +2. **Task Categories:** + - **Basic Tasks:** Primarily focused on small changes like minor bug fixes, documentation improvements, and unit testing. Labeled as **Easy**. + - **Intermediate Tasks:** Moderate-level tasks that involve enhancing existing features, code refactoring, or performance improvements. Labeled as **Medium**. + - **Advanced Tasks:** Complex tasks like building new features, significant refactoring, or critical bug fixes. Labeled as **Hard**. -3. **Acknowledging Hard Work:** - - If a contributor puts in significant effort on a task, the issue will be upgraded to **Medium**. This is our way of recognizing and appreciating extra effort. +3. **Acknowledging Effort:** + - Exceptional contributions will be recognized with a higher contribution level if substantial effort and innovation are demonstrated. -4. **Feature Additions and Component Work:** - - Contributors working on new features or components using JSX/TSX will be assigned a level based on the complexity and quality of their work. - - The more complex and valuable the contribution, the higher the level assigned. +### Review Process -### Level Definitions +- PRs will be reviewed by the maintainers, and feedback will be provided. Contributors should address feedback promptly and resubmit the PR if necessary. -- **Easy:** - - Tasks are straightforward, such as fixing minor bugs, writing tests, or making simple documentation updates. -- **Medium:** - - Tasks require more effort, such as addressing complex bugs, improving existing features, or making substantial documentation improvements. -- **Hard:** - - Tasks are highly complex and involve significant new feature development, major refactoring, or extensive contributions to the project’s core components. +- Contributors are encouraged to participate in the review process of other PRs for community growth. -We look forward to your contributions and appreciate your effort in helping us improve the project! +We appreciate your time and effort in improving this project and look forward to your valuable contributions!