|
1 |
| -## Related Issue |
2 |
| - |
3 |
| -[Cite any related issue(s) this pull request addresses. If none, simply state "None”] |
4 |
| -write issue no. here |
| 1 | +# Pull Request Template for GSoC 2024 |
5 | 2 |
|
6 |
| -## Email id used to regsiter for VSoc'24 |
| 3 | +## Related Issue |
7 | 4 |
|
| 5 | +[Please list any related issue numbers that this pull request resolves. If none, state "None"] |
8 | 6 |
|
9 |
| -## Description |
| 7 | +closes: |
10 | 8 |
|
11 |
| -[Please include a brief description of the changes or features added] |
12 | 9 |
|
13 |
| -## Type of PR |
14 | 10 |
|
15 |
| -- [ ] Bug fix |
16 |
| -- [ ] Feature enhancement |
17 |
| -- [ ] Documentation update |
18 |
| -- [ ] Security enhancement |
19 |
| -- [ ] Other (specify): _______________ |
| 11 | +## Description of Changes |
20 | 12 |
|
| 13 | +[Provide a concise description of the changes introduced by this PR, detailing what’s been added, modified, or fixed.] |
21 | 14 |
|
22 |
| -check in issue by entering [X] in boxes |
| 15 | +## Type of Pull Request |
23 | 16 |
|
24 |
| -## Screenshots / Videos (if applicable) |
| 17 | +- [ ] Bug Fix |
| 18 | +- [ ] New Feature |
| 19 | +- [ ] Performance Improvement |
| 20 | +- [ ] Documentation Update |
| 21 | +- [ ] Code Refactoring |
| 22 | +- [ ] Security Enhancement |
| 23 | +- [ ] Other (Specify): _______________ |
25 | 24 |
|
26 |
| -[Attach any relevant screenshots or videos demonstrating the changes] |
| 25 | +(Please check relevant boxes by entering an "X" inside them) |
27 | 26 |
|
28 |
| -## Checklist |
29 |
| -- [ ] I have performed a self-review of my code. |
30 |
| -- [ ] I have read and followed the Contribution Guidelines. |
31 |
| -- [ ] I have tested the changes thoroughly before submitting this pull request. |
32 |
| -- [ ] I have provided relevant issue numbers, screenshots, and videos after making the changes. |
33 |
| -- [ ] I have commented my code, particularly in hard-to-understand areas. |
34 |
| -- [ ] I have followed the code style guidelines of this project. |
35 |
| -- [ ] I have checked for any existing open issues that my pull request may address. |
36 |
| -- [ ] I have ensured that my changes do not break any existing functionality. |
37 |
| -- [ ] Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently. |
38 |
| -- [ ] I have read the resources for guidance listed below. |
39 |
| -- [ ] I have followed security best practices in my code changes. |
| 27 | +## Screenshots / Demo (if applicable) |
40 | 28 |
|
41 |
| -check in issue by entering [X] in boxes |
42 |
| -## Additional Context |
| 29 | +[Include any screenshots, GIFs, or videos that demonstrate the change or feature, if available.] |
43 | 30 |
|
44 |
| -[Include any additional information or context that might be helpful for reviewers.] |
| 31 | +## Checklist for Contributor |
| 32 | +use'X' in [ ] to check it . |
45 | 33 |
|
| 34 | +- [ ] I have reviewed my code before submission. |
| 35 | +- [ ] I have read and followed the project's Contribution Guidelines. |
| 36 | +- [ ] I have tested the code thoroughly. |
| 37 | +- [ ] I have attached related issue numbers, screenshots, or videos (if applicable). |
| 38 | +- [ ] I have added comments to my code where necessary for clarity. |
| 39 | +- [ ] I have checked the existing code base and my changes do not introduce any breaking changes. |
| 40 | +- [ ] My PR addresses only one issue; I have created separate PRs for other issues. |
| 41 | +- [ ] I have ensured that the PR does not include unrelated files. |
| 42 | +- [ ] I am mindful of the project's coding standards and best practices. |
46 | 43 |
|
| 44 | +## Additional Information |
47 | 45 |
|
| 46 | +[Include any additional context or relevant information that may help in reviewing this PR.] |
48 | 47 |
|
49 |
| -## Contribution Guidelines |
| 48 | +## Contribution Guidelines Reminder |
50 | 49 |
|
51 |
| -Thank you for considering contributing to our project! To ensure smooth collaboration and effective contribution management, please adhere to the following guidelines: |
| 50 | +Thank you for contributing to our project! Please ensure you follow the guidelines below: |
52 | 51 |
|
53 |
| -### Issue Creation |
54 | 52 |
|
55 |
| -1. **Limit on Issues:** |
56 |
| - - Each contributor is allowed to create a maximum of **4 issues per day**. This helps us manage and address issues efficiently. |
57 | 53 |
|
58 | 54 | ### Contribution Levels
|
59 | 55 |
|
60 |
| -2. **Basic Contributions:** |
61 |
| - - 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. |
62 |
| - - For these tasks, issues will be assigned the **Easy** label. |
| 56 | +2. **Task Categories:** |
| 57 | + - **Basic Tasks:** Primarily focused on small changes like minor bug fixes, documentation improvements, and unit testing. Labeled as **Easy**. |
| 58 | + - **Intermediate Tasks:** Moderate-level tasks that involve enhancing existing features, code refactoring, or performance improvements. Labeled as **Medium**. |
| 59 | + - **Advanced Tasks:** Complex tasks like building new features, significant refactoring, or critical bug fixes. Labeled as **Hard**. |
63 | 60 |
|
64 |
| -3. **Acknowledging Hard Work:** |
65 |
| - - 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. |
| 61 | +3. **Acknowledging Effort:** |
| 62 | + - Exceptional contributions will be recognized with a higher contribution level if substantial effort and innovation are demonstrated. |
66 | 63 |
|
67 |
| -4. **Feature Additions and Component Work:** |
68 |
| - - Contributors working on new features or components using JSX/TSX will be assigned a level based on the complexity and quality of their work. |
69 |
| - - The more complex and valuable the contribution, the higher the level assigned. |
| 64 | +### Review Process |
70 | 65 |
|
71 |
| -### Level Definitions |
| 66 | +- PRs will be reviewed by the maintainers, and feedback will be provided. Contributors should address feedback promptly and resubmit the PR if necessary. |
72 | 67 |
|
73 |
| -- **Easy:** |
74 |
| - - Tasks are straightforward, such as fixing minor bugs, writing tests, or making simple documentation updates. |
75 |
| -- **Medium:** |
76 |
| - - Tasks require more effort, such as addressing complex bugs, improving existing features, or making substantial documentation improvements. |
77 |
| -- **Hard:** |
78 |
| - - Tasks are highly complex and involve significant new feature development, major refactoring, or extensive contributions to the project’s core components. |
| 68 | +- Contributors are encouraged to participate in the review process of other PRs for community growth. |
79 | 69 |
|
80 |
| -We look forward to your contributions and appreciate your effort in helping us improve the project! |
| 70 | +We appreciate your time and effort in improving this project and look forward to your valuable contributions! |
0 commit comments