Skip to content

Commit 98aa49e

Browse files
dileepadevdileepadev
committed
docs: Add required documents (refs #1)
1 parent d297fc4 commit 98aa49e

15 files changed

+696
-71
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: 🐞 Bug Report
3+
about: Create a report to help us improve
4+
title: "🐞 Bug: Enter a short description of the issue"
5+
labels: "bug"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 🐞 Bug Report
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the bug. -->
14+
15+
### 🔄 Steps to Reproduce
16+
17+
<!-- [REQUIRED] List the steps to reproduce the bug. -->
18+
19+
<!-- example:
20+
1. Go to '...'
21+
2. Click on '...'
22+
3. Scroll down to '...'
23+
4. See error
24+
-->
25+
26+
### ✅ Expected Behavior
27+
28+
<!-- [REQUIRED] Describe what you expected to happen. -->
29+
30+
### ❌ Actual Behavior
31+
32+
<!-- [REQUIRED] Describe what actually happened. -->
33+
34+
### 📸 Screenshots
35+
36+
<!-- [OPTIONAL] If applicable, add screenshots to help explain your problem. Remove if not needed. -->
37+
38+
### ✨ Environment
39+
40+
<!-- [REQUIRED] Provide details about your environment. -->
41+
42+
<!-- example:
43+
- 🖥️ OS: [e.g. Windows, macOS, Linux]
44+
- 🌐 Browser: [e.g. Chrome, Firefox, Safari]
45+
- 📱 Device: [e.g., iPhone6, Laptop]
46+
- 📦 Version: [e.g. 22]
47+
- 🌈 Theme: [e.g. Dark mode, Light mode]
48+
-->
49+
50+
### 🔗 Related Issues or PRs
51+
52+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
53+
54+
### 📝 Additional Information
55+
56+
<!-- [OPTIONAL] Any additional context about the bug here. Remove if not needed. -->

‎.github/ISSUE_TEMPLATE/documentation_update.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: 📝 Documentation Update
3+
about: Propose a change to the project documentation
4+
title: "📝 Docs: Enter a short description of the issue"
5+
labels: "documentation"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 📝 Documentation Update
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the changes in this documentation update. -->
14+
15+
### 📚 Changes
16+
17+
<!-- [REQUIRED] List the specific changes made to the documentation. -->
18+
19+
### 🔗 Related Issues or PRs
20+
21+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
22+
23+
### 📝 Additional Information
24+
25+
<!-- [OPTIONAL] Any additional context about the documentation update here. Remove if not needed. -->

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 🌱 Feature Request
3+
about: Suggest a feature for this project
4+
title: "🌱 Feature: Enter a short description of the issue"
5+
labels: "feature request"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 🌱 Feature Request
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the feature and the problem or opportunity it addresses. -->
14+
15+
### 🎯 Objectives
16+
17+
<!-- [REQUIRED] List the specific objectives or goals of the feature. -->
18+
19+
<!-- example:
20+
[ ] Improve user experience by adding a search function
21+
[ ] Enhance performance by optimizing the code
22+
-->
23+
24+
### 🔗 Related Issues or PRs
25+
26+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
27+
28+
### 📝 Additional Information
29+
30+
<!-- [OPTIONAL] Any additional context about the feature request here. Remove if not needed. -->

‎.github/ISSUE_TEMPLATE/feedback.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: 📢 Feedback
3+
about: Provide feedback for this project
4+
title: "📢 Feedback: Enter a short description of the issue"
5+
labels: "feedback"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 📢 Feedback
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the feedback. -->
14+
15+
### 🔗 Related Issues or PRs
16+
17+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
18+
19+
### 📝 Additional Information
20+
21+
<!-- [OPTIONAL] Any additional context about the feedback here. Remove if not needed. -->

‎.github/ISSUE_TEMPLATE/other.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: 💡 Other Issue
3+
about: Create any other issue that doesn't fit into the other categories
4+
title: "💡 Other: Enter a short description of the issue"
5+
labels: "other"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 💡 Other Issue
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the issue. -->
14+
15+
### 🔗 Related Issues or PRs
16+
17+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
18+
19+
### 📝 Additional Information
20+
21+
<!-- [OPTIONAL] Any additional context about the issue here. Remove if not needed. -->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
about: Template for Pull Requests
3+
title: "<type>(<branch>): <message> [#issue_number]"
4+
# Example: "fix(dev): Link cards to a new username [#6]"
5+
---
6+
7+
## 📜 Description
8+
9+
<!-- [REQUIRED] Briefly describe the changes in this PR and the reasoning behind them. -->
10+
11+
## ⚙️ Type of Change
12+
13+
<!-- [REQUIRED] Check the type of change your PR introduces -->
14+
15+
- [ ] 🐞 Bug Fix
16+
- [ ] 🌱 New Feature / Enhancement
17+
- [ ] 📝 Documentation Update
18+
- [ ] 📢 User Feedback / Suggestion
19+
- [ ] 💡 Other (please explain in Description)
20+
21+
## ❗ Related Issues
22+
23+
<!-- [REQUIRED] List related issue(s) or PR(s), e.g., "Closes #123" or "Related to #456". -->
24+
25+
## 📸 Screenshots
26+
27+
<!-- [OPTIONAL] If UI-related changes were made, include before/after screenshots here. Remove if not applicable.-->
28+
29+
## ✅ Checklist
30+
31+
<!-- [REQUIRED] Tick all that apply -->
32+
33+
- [x] I've followed the [CONTRIBUTING.md](CONTRIBUTING.md).
34+
- [x] I've followed the [Commit Message Guidelines](COMMIT_MESSAGE_GUIDELINES.md).
35+
- [x] I've followed the [Branch Naming Guidelines](BRANCH_NAMING_GUIDELINES.md).
36+
- [x] I agree to follow the [Pull Request Guidelines](PULL_REQUEST_GUIDELINES.md).
37+
- [x] I agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
38+
- [x] Documentation has been updated where necessary.
39+
- [x] I've tested the changes where applicable.
40+
41+
<!-- example:
42+
- [ ] I've tested the changes where applicable:
43+
- [ ] Screen sizes (mobile/tablet/desktop)
44+
- [ ] Browsers (Chrome/Firefox/Safari/etc.)
45+
- [ ] Devices (iPhone/Android/Laptop/etc.)
46+
- [ ] Operating Systems (Windows/macOS/Linux)
47+
- [ ] Theme modes (Dark mode / Light mode)
48+
49+
-->
50+
51+
## 💬 Additional Comments
52+
53+
<!-- [OPTIONAL] Any additional context, edge cases, considerations, or explanations for reviewers. Remove if not needed. -->

‎BRANCH_NAMING_GUIDELINES.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Branch Naming Guidelines
2+
3+
When creating a new branch, please follow this naming convention to maintain consistency and clarity in communication regarding the nature of changes.
4+
5+
## Protected Branches
6+
7+
These branches are protected and can only be updated by repository administrators. As a contributor, do **not** commit directly to these branches.
8+
9+
| Branch Name | Description |
10+
| ----------- | -------------------------------------------------------------------------------------- |
11+
| `main` | The stable, production-ready version of the website. |
12+
| `dev` | The development branch containing features and bug fixes not yet ready for production. |
13+
14+
## Contributing Branches
15+
16+
These branches are open for contributions from all contributors. Follow these naming conventions when creating a new branch:
17+
18+
| Branch Name | Description |
19+
| ------------ | ------------------------------------------------------------------------------------------------------ |
20+
| `feat/x` | A branch for adding new features or enhancing functionality. Replace `x` with a short description. |
21+
| `fix/x` | A branch for fixing bugs. Replace `x` with a description of the issue being addressed. |
22+
| `docs/x` | A branch for documentation updates. Replace `x` with a description of the documentation being updated. |
23+
| `style/x` | A branch for code style changes (formatting, spacing, etc.). Replace `x` with the style change. |
24+
| `refactor/x` | A branch for code refactoring that doesn’t change functionality. Replace `x` with a description. |
25+
| `perf/x` | A branch for performance improvements. Replace `x` with the specific performance enhancement. |
26+
| `test/x` | A branch for adding or modifying tests. Replace `x` with the test being added or modified. |
27+
| `chore/x` | A branch for routine tasks or maintenance (e.g., upgrading dependencies). Replace `x` with the task. |
28+
29+
## Examples
30+
31+
Here are a few examples of valid branch names:
32+
33+
- `feat/navbar` - New feature for the navbar.
34+
- `fix/login` - Bug fix for the login functionality.
35+
- `docs/readme` - Update to the README documentation.
36+
- `style/formatting` - Code style formatting changes.
37+
- `refactor/database` - Refactor the database connection handling.
38+
- `test/authentication` - Tests for the authentication service.
39+
- `chore/dependencies` - Update dependencies.

‎CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
## [Unreleased]
6+
7+
- **No changes yet.**
8+
9+
<!-- Unreleased -->
10+
11+
[Unreleased]: https://github.com/dileepadev/api.dileepa.dev/tree/main

‎CODE_OF_CONDUCT.md

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

0 commit comments

Comments
 (0)