|
11 | 11 | - [ ] Bug fix
|
12 | 12 | - [ ] Feature enhancement
|
13 | 13 | - [ ] Documentation update
|
| 14 | +- [ ] Security enhancement |
14 | 15 | - [ ] Other (specify): _______________
|
15 | 16 |
|
16 | 17 | ## Screenshots / Videos (if applicable)
|
|
23 | 24 | - [ ] I have tested the changes thoroughly before submitting this pull request.
|
24 | 25 | - [ ] I have provided relevant issue numbers, screenshots, and videos after making the changes.
|
25 | 26 | - [ ] I have commented my code, particularly in hard-to-understand areas.
|
26 |
| -<!-- [X] - put a cross/X inside [] to check the box --> |
| 27 | +- [ ] I have followed the code style guidelines of this project. |
| 28 | +- [ ] I have checked for any existing open issues that my pull request may address. |
| 29 | +- [ ] I have ensured that my changes do not break any existing functionality. |
| 30 | +- [ ] Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently. |
| 31 | +- [ ] I have read the resources for guidance listed below. |
| 32 | +- [ ] I have followed security best practices in my code changes. |
27 | 33 |
|
28 | 34 | ## Additional Context
|
29 | 35 |
|
30 | 36 | [Include any additional information or context that might be helpful for reviewers.]
|
31 | 37 |
|
32 | 38 | ## Resources for Guidance
|
33 | 39 |
|
34 |
| -Here are some resources that may be helpful as you contribute to CodeHarborHub: |
35 |
| -- [Code Harbor Hub Community Features](https://www.codeharborhub.live/community/features) |
36 |
| -- [Docusaurus Documentation](https://docusaurus.io/docs/create-doc) |
37 |
| -- [React.js Documentation](https://legacy.reactjs.org/docs/getting-started.html) |
38 |
| -- [Markdown Guide](https://www.markdownguide.org/) |
39 |
| -- [MDX Documentation](https://mdxjs.com/docs/) |
40 |
| -- [Mermaid Documentation](https://mermaid.js.org/) |
| 40 | +Please read the following resources before submitting your contribution: |
| 41 | + |
| 42 | +- [ ] [Code Harbor Hub Community Features](https://www.codeharborhub.live/community/features) |
| 43 | +- [ ] [Docusaurus Documentation](https://docusaurus.io/docs/create-doc) |
| 44 | +- [ ] [React.js Documentation](https://legacy.reactjs.org/docs/getting-started.html) |
| 45 | +- [ ] [Markdown Guide](https://www.markdownguide.org/) |
| 46 | +- [ ] [MDX Documentation](https://mdxjs.com/docs/) |
| 47 | +- [ ] [Mermaid Documentation](https://mermaid.js.org/) |
41 | 48 |
|
42 | 49 | **Resources for DSA Features on Our Site:**
|
43 | 50 |
|
44 |
| -- Tabs: [Switch Languages](https://www.codeharborhub.live/community/features#multi-language-support-code-blocks) |
45 |
| -- [Line Numbering](https://www.codeharborhub.live/community/features#line-numbering) |
46 |
| -- [Math Equations](https://www.codeharborhub.live/community/features#math-equations-with-katex) |
| 51 | +- [ ] [Tabs: Switch Languages](https://www.codeharborhub.live/community/features#multi-language-support-code-blocks) |
| 52 | +- [ ] [Line Numbering](https://www.codeharborhub.live/community/features#line-numbering) |
| 53 | +- [ ] [Math Equations](https://www.codeharborhub.live/community/features#math-equations-with-katex) |
| 54 | + |
| 55 | +## Contribution Guidelines |
| 56 | + |
| 57 | +Thank you for considering contributing to our project! To ensure smooth collaboration and effective contribution management, please adhere to the following guidelines: |
| 58 | + |
| 59 | +### Issue Creation |
| 60 | + |
| 61 | +1. **Limit on Issues:** |
| 62 | + - Each contributor is allowed to create a maximum of **4 issues per day**. This helps us manage and address issues efficiently. |
| 63 | + |
| 64 | +### Contribution Levels |
| 65 | + |
| 66 | +2. **Basic Contributions:** |
| 67 | + - 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. |
| 68 | + - For these tasks, issues will be assigned the **level1** label. |
| 69 | + |
| 70 | +3. **Acknowledging Hard Work:** |
| 71 | + - If a contributor puts in significant effort on a task, the issue will be upgraded to **level2**. This is our way of recognizing and appreciating extra effort. |
| 72 | + |
| 73 | +4. **Feature Additions and Component Work:** |
| 74 | + - Contributors working on new features or components using JSX/TSX will be assigned a level based on the complexity and quality of their work. |
| 75 | + - The more complex and valuable the contribution, the higher the level assigned. |
| 76 | + |
| 77 | +### Level Definitions |
| 78 | + |
| 79 | +- **Level1:** |
| 80 | + - Tasks are straightforward, such as fixing minor bugs, writing tests, or making simple documentation updates. |
| 81 | +- **Level2:** |
| 82 | + - Tasks require more effort, such as addressing complex bugs, improving existing features, or making substantial documentation improvements. |
| 83 | +- **Level3:** |
| 84 | + - Tasks are highly complex and involve significant new feature development, major refactoring, or extensive contributions to the project’s core components. |
| 85 | + |
| 86 | +We look forward to your contributions and appreciate your effort in helping us improve the project! |
0 commit comments