Skip to content

Commit 6457ea7

Browse files
2 parents a90b54b + da4e2c1 commit 6457ea7

File tree

1,020 files changed

+124405
-10010
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,020 files changed

+124405
-10010
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ BASE_URL =
22
ALGOLIA_API_KEY =
33
ALGOLIA_APP_ID =
44
GTM_ID =
5-
GA_ID =
5+
GA_ID =

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ body:
1111
options:
1212
- label: I have searched the existing issues
1313
required: true
14+
1415
- type: textarea
1516
id: issue-description
1617
attributes:
@@ -19,6 +20,7 @@ body:
1920
placeholder: Describe the improvement or correction you'd like to see in the documentation.
2021
validations:
2122
required: true
23+
2224
- type: textarea
2325
id: suggested-change
2426
attributes:
@@ -27,14 +29,16 @@ body:
2729
placeholder: Explain how the documentation should be updated or corrected.
2830
validations:
2931
required: true
32+
3033
- type: textarea
3134
id: rationale
3235
attributes:
3336
label: Rationale
3437
description: Why is this documentation update necessary or beneficial?
3538
placeholder: Explain the importance or reasoning behind the suggested change.
3639
validations:
37-
required: False
40+
required: false
41+
3842
- type: dropdown
3943
id: urgency
4044
attributes:
@@ -47,14 +51,34 @@ body:
4751
default: 0
4852
validations:
4953
required: true
54+
5055
- type: checkboxes
5156
id: terms
5257
attributes:
53-
label: Record
58+
label: Acknowledgements
59+
description: Ensure you have read and agree to the project's guidelines.
5460
options:
55-
- label: "I have read the Contributing Guidelines"
61+
- label: I have read the Contributing Guidelines
5662
required: true
57-
- label: "I'm a GSSOC'24 contributor"
63+
- label: I'm a GSSOC'24 contributor
5864
required: false
59-
- label: "I have starred the repository"
65+
- label: I have starred the repository
66+
required: true
67+
- label: I have read and followed the Contribution Guidelines
68+
required: true
69+
- label: I have followed the code style guidelines of this project
70+
required: true
71+
- label: I have checked for any existing open issues that my pull request may address
72+
required: true
73+
- label: I have ensured that my changes do not break any existing functionality
74+
required: true
75+
- label: Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently
76+
required: true
77+
- label: I have read the resources for guidance listed below
78+
required: true
79+
- label: I have not used AI-generated content (e.g., ChatGPT, other AI tools)
80+
required: true
81+
- label: I have not used content from existing sites (e.g., text, images)
82+
required: true
83+
- label: I have followed all security rules and only shared trusted resources
6084
required: true

.github/dependabot.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "npm" # Using npm for Docusaurus
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"
12+
13+
- package-ecosystem: "github-actions"
14+
directory: "/"
15+
schedule:
16+
interval: "weekly"
17+
18+
- package-ecosystem: "docker"
19+
directory: "/"
20+
schedule:
21+
interval: "weekly"

.github/pull_request_template.md

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- [ ] Bug fix
1212
- [ ] Feature enhancement
1313
- [ ] Documentation update
14+
- [ ] Security enhancement
1415
- [ ] Other (specify): _______________
1516

1617
## Screenshots / Videos (if applicable)
@@ -23,24 +24,63 @@
2324
- [ ] I have tested the changes thoroughly before submitting this pull request.
2425
- [ ] I have provided relevant issue numbers, screenshots, and videos after making the changes.
2526
- [ ] 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.
2733

2834
## Additional Context
2935

3036
[Include any additional information or context that might be helpful for reviewers.]
3137

3238
## Resources for Guidance
3339

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/)
4148

4249
**Resources for DSA Features on Our Site:**
4350

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!
Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
name: Comment on Issue Close
2-
3-
on:
4-
issues:
5-
types: [closed]
6-
7-
jobs:
8-
greet-on-close:
9-
runs-on: ubuntu-latest
10-
permissions:
11-
issues: write
12-
steps:
13-
- name: Greet User
14-
uses: actions/github-script@v7
15-
with:
16-
github-token: ${{ secrets.GITHUB_TOKEN }}
17-
script: |
18-
const issue = context.payload.issue;
19-
const issueCreator = issue.user.login;
20-
const issueNumber = issue.number;
21-
22-
const greetingMessage = `Hello @${issueCreator}! Your issue #${issueNumber} has been closed. Thank you for your contribution!`;
23-
24-
github.rest.issues.createComment({
25-
owner: context.repo.owner,
26-
repo: context.repo.repo,
27-
issue_number: issueNumber,
28-
body: greetingMessage
1+
name: Comment on Issue Close
2+
3+
on:
4+
issues:
5+
types: [closed]
6+
7+
jobs:
8+
greet-on-close:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
issues: write
12+
steps:
13+
- name: Greet User
14+
uses: actions/github-script@v7
15+
with:
16+
github-token: ${{ secrets.GITHUB_TOKEN }}
17+
script: |
18+
const issue = context.payload.issue;
19+
const issueCreator = issue.user.login;
20+
const issueNumber = issue.number;
21+
22+
const greetingMessage = `Hello @${issueCreator}! Your issue #${issueNumber} has been closed. Thank you for your contribution!`;
23+
24+
github.rest.issues.createComment({
25+
owner: context.repo.owner,
26+
repo: context.repo.repo,
27+
issue_number: issueNumber,
28+
body: greetingMessage
2929
});

.github/workflows/close-old-issue.yml

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
1-
name: Close Old Issues
2-
on:
3-
schedule:
4-
- cron: "0 0 * * *"
5-
6-
jobs:
7-
close-issues:
8-
runs-on: ubuntu-latest
9-
10-
steps:
11-
- name: Checkout Repository
12-
uses: actions/checkout@v4
13-
14-
- name: Close Old Issues
15-
run: |
16-
open_issues=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
17-
"https://api.github.com/repos/${{ github.repository }}/issues?state=open" \
18-
| jq -r '.[] | .number')
19-
for issue in $open_issues; do
20-
# Get the last updated timestamp of the issue
21-
last_updated=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
22-
"https://api.github.com/repos/${{ github.repository }}/issues/$issue" \
23-
| jq -r '.updated_at')
24-
days_since_update=$(( ( $(date +%s) - $(date -d "$last_updated" +%s) ) / 86400 ))
25-
if [ $days_since_update -gt 30 ]; then
26-
curl -s -X PATCH -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
27-
-H "Accept: application/vnd.github.v3+json" \
28-
-d '{"state":"closed"}' \
29-
"https://api.github.com/repos/${{ github.repository }}/issues/$issue"
30-
31-
# Add a comment explaining when the issue will be closed
32-
curl -s -X POST -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
33-
-H "Accept: application/vnd.github.v3+json" \
34-
-d '{"body":"This issue has been automatically closed because it has been inactive for more than 30 days. If you believe this is still relevant, feel free to reopen it or create a new one. Thank you!"}' \
35-
"https://api.github.com/repos/${{ github.repository }}/issues/$issue/comments"
36-
fi
1+
name: Close Old Issues
2+
on:
3+
schedule:
4+
- cron: "0 0 * * *"
5+
6+
jobs:
7+
close-issues:
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- name: Checkout Repository
12+
uses: actions/checkout@v4
13+
14+
- name: Close Old Issues
15+
run: |
16+
open_issues=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
17+
"https://api.github.com/repos/${{ github.repository }}/issues?state=open" \
18+
| jq -r '.[] | .number')
19+
for issue in $open_issues; do
20+
# Get the last updated timestamp of the issue
21+
last_updated=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
22+
"https://api.github.com/repos/${{ github.repository }}/issues/$issue" \
23+
| jq -r '.updated_at')
24+
days_since_update=$(( ( $(date +%s) - $(date -d "$last_updated" +%s) ) / 86400 ))
25+
if [ $days_since_update -gt 30 ]; then
26+
curl -s -X PATCH -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
27+
-H "Accept: application/vnd.github.v3+json" \
28+
-d '{"state":"closed"}' \
29+
"https://api.github.com/repos/${{ github.repository }}/issues/$issue"
30+
31+
# Add a comment explaining when the issue will be closed
32+
curl -s -X POST -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
33+
-H "Accept: application/vnd.github.v3+json" \
34+
-d '{"body":"This issue has been automatically closed because it has been inactive for more than 30 days. If you believe this is still relevant, feel free to reopen it or create a new one. Thank you!"}' \
35+
"https://api.github.com/repos/${{ github.repository }}/issues/$issue/comments"
36+
fi
3737
done

.github/workflows/close-old-pr.yml

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
name: Close Stale PRs
2-
3-
on:
4-
schedule:
5-
- cron: '0 0 * * *' # Runs daily at midnight
6-
pull_request:
7-
types:
8-
- opened
9-
- reopened
10-
- synchronize
11-
12-
permissions:
13-
pull-requests: write
14-
issues: write
15-
16-
jobs:
17-
close_stale_prs:
18-
runs-on: ubuntu-latest
19-
permissions:
20-
pull-requests: write
21-
22-
steps:
23-
- uses: actions/stale@v9
24-
with:
25-
repo-token: ${{ secrets.GITHUB_TOKEN }}
26-
stale-pr-message: 'This PR has been automatically closed due to inactivity from the owner for 15 days.'
27-
days-before-pr-stale: 15
28-
days-before-pr-close: 0
29-
exempt-pr-author: false
30-
exempt-pr-labels: ''
31-
only-labels: ''
32-
operations-per-run: 30
33-
remove-stale-when-updated: true
1+
name: Close Stale PRs
2+
3+
on:
4+
schedule:
5+
- cron: '0 0 * * *' # Runs daily at midnight
6+
pull_request:
7+
types:
8+
- opened
9+
- reopened
10+
- synchronize
11+
12+
permissions:
13+
pull-requests: write
14+
issues: write
15+
16+
jobs:
17+
close_stale_prs:
18+
runs-on: ubuntu-latest
19+
permissions:
20+
pull-requests: write
21+
22+
steps:
23+
- uses: actions/stale@v9
24+
with:
25+
repo-token: ${{ secrets.GITHUB_TOKEN }}
26+
stale-pr-message: 'This PR has been automatically closed due to inactivity from the owner for 15 days.'
27+
days-before-pr-stale: 15
28+
days-before-pr-close: 0
29+
exempt-pr-author: false
30+
exempt-pr-labels: ''
31+
only-labels: ''
32+
operations-per-run: 30
33+
remove-stale-when-updated: true
3434
debug-only: false

0 commit comments

Comments
 (0)