Skip to content

Commit

Permalink
Merge branch 'jfmartinz:main' into patch-3
Browse files Browse the repository at this point in the history
  • Loading branch information
sau-mili authored Jun 7, 2024
2 parents 32957fc + 5350999 commit 7a4a95f
Show file tree
Hide file tree
Showing 56 changed files with 9,853 additions and 1,026 deletions.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/documentationbug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: "📃 Documentation"
description: Document issue or enhancement?
title: "📃 [ENHANCEMENT] - <title>"
labels: ["documentation"]
body:
- type: checkboxes
id: terms
attributes:
label: Issue Verification
description: Before you open an issue, please verify that it's indeed a documentation issue and hasn't been reported before.
options:
- label: I have verified that this is a new documentation issue.
required: true
- label: I'm interested in working on this issue
required: true
- label: I'm part of GSSOC organization
required: true
- type: textarea
id: documentation-area
attributes:
label: Documentation Area📚
description: Please specify the area or section of the documentation that needs attention.
placeholder: Describe the area that needs attention.
validations:
required: false
- type: textarea
id: issue-description
attributes:
label: Issue Description✍️
description: Describe the documentation issue or improvement needed.
placeholder: Explain the issue.
validations:
required: false
- type: textarea
id: relevant-links
attributes:
label: Relevant Links🔗
description: Provide any relevant links, if applicable.
placeholder: Add links.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Additional information about the documentation (Optional).
validations:
required: false
- type: checkboxes
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [CODE OF CONDUCT](https://github.com/jfmartinz/ResourceHub/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I follow the [CONTRIBUTING GUIDELINE](https://github.com/jfmartinz/ResourceHub/blob/main/CONTRIBUTING.md) of this project.
required: true
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/resource.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: "➕ Add a Resource"
description: Want to add a new Resource?
title: "➕ [RESOURCE] - <title>"
labels: ["resource"]
body:
- type: checkboxes
id: terms
attributes:
label: Idea Contribution
description: Before you open an issue, please check if a similar issue already exists or has been closed before.
options:
- label: I have read all the resource request issues.
required: true
- label: I'm interested in working on this issue
required: true
- label: I'm part of GSSOC organization
required: true
- type: textarea
id: category_and_section
attributes:
label: Where do you want to add the resource? Specify the category and section.
description: Where do you want to add the resource? Specify the category and section.
placeholder: Provide a clear and concise description of your resource.
validations:
required: false
- type: textarea
id: resource_urls
attributes:
label: Provide the URLs of the resources you are adding
description: Provide the URLs of the resources you are adding.
placeholder: Give a clear and concise description of the desired outcome.
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Any alternative approaches/features
description: Have you considered any alternative approaches or features?
placeholder: Provide a clear and concise description of any other solutions or functionalities you've contemplated.
validations:
required: false
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Include any extra information or visuals that may be relevant to the feature request.
validations:
required: false
- type: checkboxes
id: code_of_conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [CODE OF CONDUCT](https://github.com/jfmartinz/ResourceHub/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I follow the [CONTRIBUTING GUIDELINE](https://github.com/jfmartinz/ResourceHub/blob/main/CONTRIBUTING.md) of this project.
required: true
36 changes: 17 additions & 19 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
**IMPORTANT:** When creating your Pull Request, please use the following format for the title: `Category - Resource Name & Section` <!--Change the PR Title not this -->
# Pull Request

PR Title samples:
## Description
Please include a summary of the changes and the related issue.

- `Web development - CSS Portal & Tools`
- `Web development - Leetcode & Challenges`
Closes #

## Type of change
- [ ] Adding a new Resource
- [ ] Adding a new Category
- [ ] Documentation enhancement or fixes
- [ ] Website enhancement or fixes

Closes #10
## Checklist:
- [ ] I read carefully [CONTRIBUTING.md](https://github.com/jfmartinz/ResourceHub/blob/main/CONTRIBUTING.md)
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation


### Description:
> Provide a brief description of the pull request
## Screenshots (if appropriate):

Please add screenshots to help explain your changes.

### Resource URL:
> Insert the URL of the resource you're proposing
-
-
-

### Checklist:
Before submitting your pull request, ensure that you have completed the following tasks:

- [ ] I have carefully reviewed and adhered to the [contributing guidelines](https://github.com/jfmartinz/ResourceHub/blob/main/CONTRIBUTING.md) before creating this pull request.
- [ ] I followed the prescribed PR title template. _(Check this if you're adding a resource)_

> fill the bracket with x. Something like this [x]
## Additional
17 changes: 12 additions & 5 deletions .github/workflows/autocomment.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Auto Comment on PR Merge

on:
pull_request:
pull_request_target:
types: [closed]

permissions:
Expand All @@ -13,20 +13,27 @@ jobs:
if: github.event.pull_request.merged == true
runs-on: ubuntu-latest

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

steps:
- name: Add Comment to Merged PR
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
COMMENT=$(cat <<EOF
{
"body": "🎉 Your pull request has been successfully merged! 🎉 Thank you for your valuable contribution to our project. Your efforts are greatly appreciated. Feel free to reach out if you have any more contributions or if there's anything else we can assist you with. Keep up the fantastic work! 🚀"
}
EOF
)
curl -X POST \
RESPONSE=$(curl -s -o response.json -w "%{http_code}" \
-X POST \
-H "Authorization: Bearer $GITHUB_TOKEN" \
-H "Accept: application/vnd.github.v3+json" \
-H "Content-Type: application/json" \
https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments \
-d "$COMMENT"
-d "$COMMENT")
cat response.json
if [ "$RESPONSE" -ne 201 ]; then
echo "Failed to add comment"
exit 1
fi
27 changes: 27 additions & 0 deletions .github/workflows/preview.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Vercel Preview Deployment

env:
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}

on:
pull_request:
branches:
- main

jobs:
Deploy-Preview:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Vercel CLI
run: npm install --global vercel

- name: Pull Vercel Environment Information
run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}

- name: Build Project Artifacts
run: vercel build --token=${{ secrets.VERCEL_TOKEN }}

- name: Deploy Project Artifacts
run: vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }}
27 changes: 27 additions & 0 deletions .github/workflows/production.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Vercel Production Deployment

env:
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}

on:
push:
branches:
- main

jobs:
Deploy-Production:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Vercel CLI
run: npm install --global vercel

- name: Pull Vercel Environment Information
run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}

- name: Build Project Artifacts
run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}

- name: Deploy Project Artifacts
run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
30 changes: 16 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ To ensure a smooth experience, please follow these important rules:

1. **Relevance:** Ensure that the resource you're adding aligns with the appropriate category. Web development resources belong in the web development category, UI/UX design resources in the UI/UX design category, and so forth. Additionally, ensure that your resource aligns with the specific section of the category. For example, if you have a resource named ["anime.js"](https://animejs.com/), it should be placed in the [web development](https://github.com/jfmartinz/ResourceHub/tree/main/Web%20Development) category under the [animation](https://github.com/jfmartinz/ResourceHub/tree/main/Web%20Development#animations) section. This precision ensures that users can easily locate and benefit from the resources in their intended context.
2. **Use the PR and Issue Template:** When creating a PR or Issue, please follow the specified template, it will help me to review your Issue or PR more efficient.

3. **Category** refers to topics such as Web Development, Web3, or UI/UX Design.
4. **Section** refers to a specific part within a category. For example, in the Database category, we have a section called [Challenges](https://github.com/jfmartinz/ResourceHub/tree/main/DBMS%20(Database)#challenges).

### How to Add a Resource

Expand Down Expand Up @@ -45,35 +46,36 @@ Example:
There are many ways to contribute, and you don't need to be a coding wizard to get involved. Here are some beginner-friendly ways to contribute:

### Share Your Ideas
> We value your input, whether it's proposing a new section to a category, suggesting additional categories, or sharing any ideas for the project's enhancement.
We value your input, whether it's proposing a new section to a category, suggesting additional categories, or sharing any ideas for the project's enhancement.

Here's how you can contribute your ideas:

1. **Raise an Issue:** Start a discussion by creating an issue. Describe your idea, and I'll review it if it aligns to the project's goal.
2. **Direct Message:** Feel free to reach out to me personally. You can connect with me on [LinkedIn](https://www.linkedin.com/in/jfmartinz/) or reach out via [Twitter](https://twitter.com/jfmartinz).

### Add Valuable Resources
> If you come across a resource that you believe would benefit others, we encourage you to share it with us. Here's how you can contribute valuable resources:
If you come across a resource that you believe would benefit others, we encourage you to share it with us.

Here's how you can contribute valuable resources:

1. Review the **[Rules](https://github.com/jfmartinz/ResourceHub/edit/main/CONTRIBUTING.md#important-rules)** for Adding Resources: Carefully read and understand the guidelines on how to add a resource, the format used for adding new resource, and etc.

**Ensure that you followed the specified issue template**

### Grammatical Errors
> Help us maintain clean and error-free content by fixing typos or grammar issues. Your attention to detail ensures a seamless reading experience for everyone involved.
1. **Create a PR:** If you notice any grammatical errors or typos, please create a Pull Request (PR) directly. Your contributions help us maintain the quality and accuracy of our project.
Help us maintain clean and error-free content by fixing typos or grammar issues. Your attention to detail ensures a seamless reading experience for everyone involved.

### Enhance Documentation
> Improving our project documentation is crucial for creating a user-friendly experience. If you have ideas on how to enhance the current documentation, please share them.
Improving our project documentation is crucial for creating a user-friendly experience. If you have ideas on how to enhance the current documentation, please share them.

1. **Raise an Issue:** Start a discussion about your documentation improvement ideas. Perhaps you've identified areas where we can enhance the documentation for a better user experience, making it more user-friendly and accessible. Share your insights to help us continually improve.

### Report Outdated or Broken Links
> Help us maintain the reliability of our resources by reporting any broken links or outdated information.
1. **Create a PR:** If you come across outdated or broken links, please create a Pull Request (PR) directly. Include details on the category or location where you found the issue. This will help us swiftly address and update the information.

Help us maintain the reliability of our resources by reporting any broken links or outdated information. Include details on the category or location where you found the issue. This will help us swiftly address and update the information.

### Others
Here are other ways you can contribute to ResourceHub:
- Adding new sections within a category.
- Removing or relocating resources that are not relevant to the current section or category.
- Enhancing categories through formatting, adding new resources, and more.
- Any other contributions you can think of—just send a personal message so we can discuss it.
---


Expand Down
Loading

0 comments on commit 7a4a95f

Please sign in to comment.