Skip to content

Commit a49dd9b

Browse files
shadil-rayyanshadil-rayyan
committed
added a .github folder and files
1 parent 9e7ee89 commit a49dd9b

File tree

12 files changed

+1012
-0
lines changed

12 files changed

+1012
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official email address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎.github/CONTRIBUTING.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
2+
# Contributing to the Project
3+
4+
Thank you for your interest in contributing to this **Next.js web development project**! We welcome contributions of all kinds, including **bug fixes, new features, performance optimizations, UI enhancements, and documentation improvements**.
5+
6+
Please follow these guidelines to ensure a smooth and collaborative development process.
7+
8+
---
9+
10+
## 📌 Getting Started
11+
12+
### 🔹 Fork and Clone the Repository
13+
14+
1. **Fork** the repository on GitHub.
15+
2. **Clone** your fork to your local machine:
16+
```sh
17+
git clone https://github.com/your-username/your-project.git
18+
```
19+
3. Navigate into the project directory:
20+
```sh
21+
cd your-project
22+
```
23+
4. Add the upstream repository to keep your fork updated:
24+
```sh
25+
git remote add upstream https://github.com/original-author/your-project.git
26+
```
27+
5. Pull the latest changes from the upstream repository:
28+
```sh
29+
git pull upstream main
30+
```
31+
32+
### 🔹 Install Dependencies
33+
34+
Ensure you have **Node.js (LTS)** installed, along with **npm** or **yarn**. Then install project dependencies:
35+
```sh
36+
npm install
37+
# or
38+
yarn install
39+
```
40+
41+
### 🔹 Running the Project Locally
42+
43+
Start the development server:
44+
```sh
45+
npm run dev
46+
# or
47+
yarn dev
48+
```
49+
Visit `http://localhost:3000` in your browser to see the project running.
50+
51+
---
52+
53+
## 🚀 Contribution Workflow
54+
55+
### 🔹 Reporting Issues
56+
57+
Before opening a new issue, check the **[existing issues](https://github.com/original-author/your-project/issues)** to avoid duplicates.
58+
59+
If you encounter a bug or have a feature request:
60+
61+
1. **Describe the issue** clearly, including expected vs. actual behavior.
62+
2. Provide **steps to reproduce** the issue if applicable.
63+
3. Suggest possible solutions if you have any ideas.
64+
65+
### 🔹 Submitting a Pull Request (PR)
66+
67+
1. **Create a new branch** from `main`:
68+
```sh
69+
git checkout -b feature/your-feature
70+
```
71+
2. Implement your changes while following the project’s coding and styling standards.
72+
3. **Test your changes** to ensure they work correctly:
73+
```sh
74+
npm run test
75+
```
76+
4. **Commit your changes** with a meaningful message:
77+
```sh
78+
git commit -m "feat: add new feature"
79+
```
80+
5. **Push your branch** to GitHub:
81+
```sh
82+
git push origin feature/your-feature
83+
```
84+
6. **Open a Pull Request (PR)** and provide a **clear description** of your changes.
85+
7. Address any feedback from maintainers and update your PR if necessary.
86+
87+
---
88+
89+
## 📏 Code Guidelines
90+
91+
### 🔹 Code Style
92+
93+
- Follow **Next.js best practices** for web development.
94+
- Write **clean, modular, and maintainable** code.
95+
- Ensure consistent formatting with **ESLint and Prettier**:
96+
```sh
97+
npm run lint
98+
```
99+
100+
### 🔹 Commit Message Convention
101+
102+
Use **[Conventional Commits](https://www.conventionalcommits.org/)** for commit messages:
103+
```
104+
type(scope): message
105+
```
106+
Examples:
107+
- `feat(auth): add user authentication`
108+
- `fix(ui): resolve mobile navigation issue`
109+
- `chore(deps): update dependencies`
110+
111+
### 🔹 Branch Naming Convention
112+
113+
Use a structured naming convention for branches:
114+
- **Features:** `feature/your-feature-name`
115+
- **Bug Fixes:** `fix/your-bug-fix`
116+
- **Documentation Updates:** `docs/update-docs`
117+
118+
---
119+
120+
## 🤝 Community Guidelines
121+
122+
- Be **respectful** and **inclusive** in all discussions.
123+
- Keep discussions **constructive** and **focused on solutions**.
124+
- Follow the **[Code of Conduct](CODE_OF_CONDUCT.md)** (if applicable).
125+
126+
---
127+
128+
## 💡 Need Help?
129+
130+
Join discussions in GitHub issues or reach out to the maintainers for assistance.
131+
132+
Your contributions make this project better—thank you! 🚀

‎.github/ISSUE_TEMPLATE/bug-report.yaml‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
name: Bug Report
2+
3+
description: Report an issue encountered while using the web application.
4+
5+
labels:
6+
- kind/bug
7+
8+
body:
9+
- type: textarea
10+
id: problem
11+
attributes:
12+
label: What happened?
13+
description: |
14+
Describe the issue in detail, including any incorrect behavior, broken UI elements, or unexpected functionality.
15+
If this is a security-related issue, please report it privately via the appropriate security channels (if applicable).
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: expected
21+
attributes:
22+
label: What did you expect to happen?
23+
description: Explain the expected behavior of the web application.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: repro
29+
attributes:
30+
label: Steps to Reproduce
31+
description: Provide step-by-step instructions to reproduce the issue.
32+
value: |
33+
1. Go to '...'
34+
2. Click on '...'
35+
3. Scroll down to '...'
36+
4. See the error
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: browserInfo
42+
attributes:
43+
label: Browser and Device Information
44+
description: |
45+
Specify the browser (Chrome, Firefox, Edge, Safari) and version, as well as the device type (Desktop, Mobile, Tablet).
46+
value: |
47+
<details>
48+
49+
```console
50+
# Example:
51+
Browser: Chrome 120.0.0.0
52+
OS: Windows 11 / macOS 14.0 / Ubuntu 22.04
53+
Device: Desktop / Mobile / Tablet
54+
```
55+
56+
</details>
57+
58+
- type: textarea
59+
id: softwareVersion
60+
attributes:
61+
label: Application Version
62+
description: |
63+
Specify the version of the web application where you encountered this issue. If applicable, include branch, deployment stage (staging, production), or release version.
64+
65+
- type: textarea
66+
id: environment
67+
attributes:
68+
label: Environment Details
69+
description: |
70+
Provide any relevant environment details such as API endpoints, database versions, or hosting provider.
71+
value: |
72+
<details>
73+
74+
```console
75+
# Example:
76+
Frontend: Next.js 14.0.2
77+
Backend: Node.js 18 / Express.js
78+
Database: PostgreSQL 15 / Firebase
79+
Hosting: Vercel / Netlify / AWS
80+
```
81+
82+
</details>
83+
84+
- type: textarea
85+
id: installTools
86+
attributes:
87+
label: Installation or Deployment Method
88+
description: Specify how the web app is deployed (e.g., Vercel, Netlify, Docker, custom server setup).
89+
90+
- type: textarea
91+
id: dependencies
92+
attributes:
93+
label: Related Dependencies or Packages
94+
description: |
95+
List any third-party libraries, plugins, or frameworks that might be related to the issue.
96+
value: |
97+
<details>
98+
99+
```json
100+
{
101+
"react": "18.2.0",
102+
"next": "14.0.2",
103+
"tailwindcss": "3.4.1"
104+
}
105+
```
106+
107+
</details>
108+
109+
- type: textarea
110+
id: logs
111+
attributes:
112+
label: Console Errors or Network Logs
113+
description: |
114+
Provide any browser console errors, API response errors, or logs from the network tab that could help debug the issue.
115+
value: |
116+
<details>
117+
118+
```console
119+
# Paste relevant logs or errors here.
120+
```
121+
122+
</details>
123+
124+
- type: textarea
125+
id: additional
126+
attributes:
127+
label: Additional Context
128+
description: Include any other information that might help diagnose the issue (e.g., screenshots, recordings, related issues).

‎.github/ISSUE_TEMPLATE/config.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
contact_links:
2+
- name: Support Request
3+
url: [email protected]

0 commit comments

Comments
 (0)