Skip to content

Commit

Permalink
Merge branch 'main' into feature/scroll-progress-bar
Browse files Browse the repository at this point in the history
  • Loading branch information
shashankgoud18 authored Oct 8, 2024
2 parents 51252cf + e8d132d commit a97d149
Show file tree
Hide file tree
Showing 31 changed files with 1,530 additions and 239 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* text=auto
*.json text eol=lf
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: ​🐞 Bug
description: Report an issue to help us improve the project.
title: "[BUG] <write a small description here>"
labels: ["bug", "goal: fix", "priority: medium"]
body:
- type: textarea
attributes:
label: Description
description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work.
validations:
required: false
- type: textarea
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: textarea
attributes:
label: Any additional information?
description: Any additional information or Is there anything we should know about this bug?
validations:
required: false
- type: dropdown
attributes:
label: What browser are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing [issues](https://github.com/swaraj-das/Collect-your-GamingTools/issues)."
required: true
- label: "I have read the [Code Of Conduct](https://github.com/swaraj-das/Collect-your-GamingToolst/blob/main/CODE_OF_CONDUCT.md)"
required: true
- label: "The changes don't break the code"
required: true
- label: "Please attach the screenshots and video of the development work once it is done "
required: true


40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/document.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: "Documentation 📋"
description: "Use this form to present your suggestions on how to improve our docs"
title: "[DOCS] <write your suggestion here>"
labels: ["documenation", "goal: enhancement"]

body:
- type: textarea
id: docs_description
attributes:
label: "Issue Description"
description: "Please provide a brief summary of the documentation issue you are experiencing or would like to address."
validations:
required: true

- type: textarea
id: screenshots_examples_docs
attributes:
label: "Screenshots or Examples (if applicable)"
description: "Please include relevant screenshots or examples to help illustrate the problem."

- type: textarea
id: proposed_solution_docs
attributes:
label: "Proposed Solution (optional)"
description: "If you have a proposed solution for the documentation issue, please provide it here. This can be helpful for speeding up the resolution process."

- type: checkboxes
id: terms_checklist_docs
attributes:
label: "Checklist"
description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/swaraj-das/Collect-your-GamingTools/blob/main/CODE_OF_CONDUCT.md)"
options:
- label: "I have checked the existing [issues](https://github.com/swaraj-das/Collect-your-GamingTools/issues)."
required: true

- label: "The changes don't break the code"
required: true
- label: "Please attach the screenshots and video of the development work once it is done "
required: true

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Feature Request 💡
description: Have any new idea or new feature for Collect-your-GamingTools? Please suggest!
title: "[Feature] <write a small description here>"
labels: ["enhancement", "goal: addition", "priority: high"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of any alternative solution or features you've considered.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing [issues](https://github.com/swaraj-das/Collect-your-GamingTools/issues)."
required: true

- label: "I have read the [Code Of Conduct](https://github.com/swaraj-das/Collect-your-GamingTools/blob/main/CODE_OF_CONDUCT.md)"
required: true

- label: "The changes don't break the code"
required: true
- label: "Please attach the screenshots and video of the development work once it is done "
required: true
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Other
description: Use this for any other question or issue. Please do not create blank issues
title: "[OTHER]"
labels: ["status: awaiting triage"]
body:
- type: textarea
id: issuedescription
attributes:
label: What would you like to share or ask?
description: Provide a clear and concise explanation of your issue.
validations:
required: true
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing [issues](https://github.com/Collect-your-GamingTools/issues)."
required: true

- label: "I have read the [Code Of Conduct](https://github.com/Collect-your-GamingTools/blob/main/CODE_OF_CONDUCT.md)"
required: true

- label: "The changes don't break the code"
required: true
- label: "Please attach the screenshots and video of the development work once it is done "
required: true
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor_code.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Refactor Code 🔧
description: Use this label for code refactoring tasks.
title: "[Refactor] <write what you want to add>"
labels: ["goal: refactor", "priority: medium"]
body:
- type: input
attributes:
label: File Name
description: "Enter the file that you want to refactor in the codebase."
placeholder: "For example - component/Cards/Card.tsx"
validations:
required: true
- type: textarea
id: refactor_description
attributes:
label: "Reason for Refactoring the Code"
description: "Describe what improvements can be made in the codebase without introducing breaking changes."
validations:
required: true
- type: checkboxes
id: no-duplicate-issues


attributes:
label: "Checklist"
options:

- label: "I have checked the existing [issues](https://github.com/Collect-your-GamingTools/issues)."
required: true


- label: "I have read the [Code Of Conduct](https://github.com/Collect-your-GamingTools/blob/main/CODE_OF_CONDUCT.md)"
required: true

- label: "The changes don't break the code"
required: true
- label: "Please attach the screenshots and video of the development work once it is done "
required: true


38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/task_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: ​Task Request
description: This is Only For Project Admins and Mentors.
title: " <write a small description here>"
labels: ["priority: high"]
body:
- type: textarea
attributes:
label: Description
description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work.
validations:
required: false
- type: textarea
attributes:
label: Screenshots
description: Please add screenshots if required
validations:
required: false
- type: textarea
attributes:
label: Any additional Details?
description: Please Provide Key Details, if required (Goals and objectives,Deliverables,Dependencies)
validations:
required: false
- type: textarea
attributes:
label: Deadline
description: Specify the task deadline
validations:
required: true

- type: markdown
attributes:
value: "Stay you can start working on it by taking latest pull from main branch"





2 changes: 1 addition & 1 deletion .github/workflows/auto-label-action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
permissions:
issues: write
pull-requests: write
contents: write # Required to read repository contents

jobs:
label:
Expand All @@ -24,6 +25,5 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
labels: |
hacktoberfest
hacktoberfest-accepted
gssoc-ext
60 changes: 60 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@


# 🎮 Contributing to Collect Your GamingTools Repository

Thank you for your interest in contributing to **Collect Your GamingTools**! We’re excited to see what creative ideas you bring. Follow these simple guidelines below to get started.

---

## 🚀 Getting Started

1. **Fork the Repository**
Click the "Fork" button at the top-right corner to create your own copy of the repo.

2. **Clone Your Fork**
Clone your forked repository to your local machine:
```bash
git clone https://github.com/<your-github-username>/Collect-your-GamingTools.git
```

3. **Create a New Branch**
Create a new branch for your changes:
```bash
git checkout -b feature/your-feature-name
```

---

## 🖌️ Making Changes

1. **Code Changes**
Make your modifications, ensuring they align with the project’s coding standards and code of conduct. Add exciting features, enriching documentation or squash bugs!

2. **Commit Your Changes**
Write meaningful commit messages:
```bash
git commit -m "Add: New navigation bar feature"
```

3. **Push Your Changes**
Push your changes to your forked repository:
```bash
git push origin feature/your-feature-name
```

---

## 🛠️ Creating a Pull Request

1. Once your changes are pushed, create a pull request (PR) on the original repository.
2. Provide a detailed description of your changes and link any relevant issues. Provide relevant images/videos, if any.
3. Wait for reviews and engage with feedback!

---

## 🎉 Additional Notes

- Make sure to sync your fork with the latest changes from the original repo before pushing new features.
- Respect coding conventions and keep your code clean. Comment your changes for ease in review.

Welcome to Open-Source and thank you for contributing! 🙌
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ A <b> responsive and dynamic website </b> to showcase the best gaming accessorie

## 🚀 Demo
#### Check out the live demo here ⬇️ :
https://swaraj-das.github.io/Collect-your-GamingTools/
https://collect-your-gaming-tools-7r1z88vx4-swaraj-das-projects.vercel.app/


## 🛠️ Installation
Expand All @@ -47,7 +47,20 @@ Contributions are what make the **open-source** community such an amazing place

🔃 Open a <b>pull request</b>.

We welcome all contributions to improve **Collect Your GamingTools**! If you'd like to contribute, please follow the [Contributing.md](./Contributing.md) to get details on how to get started.

## 👥 Team

| ![Swaraj Das](https://avatars.githubusercontent.com/u/151845349?v=4&s=80) | ![Anit Sarkar](https://avatars.githubusercontent.com/u/135215478?v=4&s=80) |
|:--:|:--:|
| **Swaraj Das** <br> <sub>Project Admin</sub> | **Anit Sarkar** <br> <sub>Maintainer</sub> |
| [![LinkedIn](https://img.icons8.com/fluency/32/000000/linkedin.png)](https://www.linkedin.com/in/swarajdas01/) | [![LinkedIn](https://img.icons8.com/fluency/32/000000/linkedin.png)](https://www.linkedin.com/in/anit-sarkar-11906a283/) |

## 🙌 Contributors

<a href="https://github.com/rahulsainlll/git-trace/graphs/contributors">
<img src="https://contrib.rocks/image?repo=swaraj-das/Collect-your-GamingTools" />
</a>



## 👨‍💻 Author
### Created with ❤️ by Swaraj Das
Loading

0 comments on commit a97d149

Please sign in to comment.