Skip to content

Commit 07c718f

Browse files
shadil-rayyanshadil-rayyan
authored
Merge pull request #9 from nayna-G/feature2-clean
documentation updated
2 parents 594c544 + 938460f commit 07c718f

File tree

7 files changed

+506
-59
lines changed

7 files changed

+506
-59
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: "Bug Report"
2+
description: "Report a bug to help us improve DevSetup"
3+
title: "[BUG] "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Thanks for reporting a bug!
11+
Please provide enough detail to help us reproduce and fix the issue quickly.
12+
13+
- type: textarea
14+
id: bug-description
15+
attributes:
16+
label: "Bug Description"
17+
description: "Describe the bug clearly and concisely."
18+
placeholder: |
19+
What is the incorrect behavior and what should happen instead?
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: reproduction-steps
25+
attributes:
26+
label: "Steps to Reproduce"
27+
description: "Provide step-by-step instructions to reproduce the bug."
28+
placeholder: |
29+
1. Go to '...'
30+
2. Click '...'
31+
3. Observe '...'
32+
validations:
33+
required: true
34+
35+
- type: dropdown
36+
id: severity
37+
attributes:
38+
label: "Severity"
39+
description: "How severe is this bug?"
40+
options:
41+
- "Low - Minor issue, workaround available"
42+
- "Medium - Affects functionality but not critical"
43+
- "High - Major functionality broken"
44+
- "Critical - Application unusable or data loss"
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: environment
50+
attributes:
51+
label: "Environment"
52+
description: "Provide key environment details (OS, browser, project version)."
53+
placeholder: |
54+
• OS:
55+
• Browser:
56+
• DevSetup Version:
57+
validations:
58+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# GitHub Issue Templates Configuration for DevSetup
2+
3+
# Allow blank issues
4+
blank_issues_enabled: true
5+
6+
# Default guidance for blank issues
7+
blank_issue_title: "Please provide a descriptive title for your issue"
8+
blank_issue_body: |
9+
<!--
10+
Thank you for creating an issue!
11+
Please provide a clear description to help us understand and address your concern.
12+
-->
13+
14+
## Description
15+
<!-- Describe the issue or request -->
16+
17+
## Context / Environment
18+
<!-- Include any relevant environment info or background -->
19+
20+
## Additional Information
21+
<!-- Attach screenshots, logs, or other helpful details -->
22+
23+
# Helpful links for contributors
24+
contact_links:
25+
- name: 📃 Documentation Issues
26+
url: https://github.com/CodeCompass/DevSetup/issues/new?labels=documentation
27+
about: For documentation-related issues, please use this link.
28+
29+
- name: 🤔 Questions & Help
30+
url: https://github.com/CodeCompass/DevSetup/discussions
31+
about: For questions or help, please use discussions instead of opening an issue.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: "Feature Request"
2+
description: "Suggest an idea or enhancement for this project"
3+
title: "[FEATURE] "
4+
labels: ["enhancement", "needs-triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Thanks for your feature suggestion!
11+
Please provide enough detail to help us understand your idea and its impact.
12+
13+
- type: textarea
14+
id: feature-description
15+
attributes:
16+
label: "Feature Description"
17+
description: "What is the feature or improvement?"
18+
placeholder: |
19+
Describe the feature clearly. What should it do? What problem does it solve?
20+
21+
- type: textarea
22+
id: motivation
23+
attributes:
24+
label: "Motivation / Rationale"
25+
description: "Why is this feature important?"
26+
placeholder: |
27+
Explain why this feature matters and how it benefits users or improves the project.
28+
29+
- type: dropdown
30+
id: priority
31+
attributes:
32+
label: "Priority Level"
33+
description: "How important is this feature?"
34+
options:
35+
- "Low - Nice to have"
36+
- "Medium - Would improve workflow"
37+
- "High - Significant impact"
38+
- "Critical - Blocking important use cases"
39+
40+
- type: textarea
41+
id: demo
42+
attributes:
43+
label: "Demo / Mockup (Optional)"
44+
description: "Add screenshots, mockups, or links to prototypes if available"
45+
placeholder: |
46+
Paste images, GIFs, or links here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Related Issue(s)
2+
3+
Closes #ISSUE_NUMBER
4+
5+
## What kind of change does this PR introduce?
6+
7+
- [ ] Bugfix
8+
- [ ] Feature
9+
- [ ] Documentation
10+
11+
## Why this change?
12+
13+
Briefly describe the motivation and what problem this solves
14+
15+
## Demo / Preview
16+
17+
- **Live Demo:** [Insert link here]
18+
- **Screenshots / GIFs:**
19+
![Before] → ![After]
20+
21+
## Checklist
22+
23+
- [ ] Code follows project style guidelines
24+
- [ ] Tests added / updated as needed
25+
- [ ] Documentation updated accordingly (README, CONTRIBUTING, etc.)
26+
- [ ] No sensitive data or credentials included
27+
- [ ] Verified for performance or security impact (if applicable)
28+
29+
30+
## Additional Info (Optional)

‎CODE_OF_CONDUCT.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
![Welcome Badge](https://img.shields.io/badge/Welcome-Contributors-blue?style=for-the-badge)
4+
![Respect Badge](https://img.shields.io/badge/Respect-Always-green?style=for-the-badge)
5+
![No Harassment](https://img.shields.io/badge/No%20Harassment-🚫-red?style=for-the-badge)
6+
![Inclusivity Badge](https://img.shields.io/badge/🌍-Inclusivity-purple?style=for-the-badge)
7+
8+
---
9+
10+
## Our Pledge
11+
12+
We, as **members, contributors, and leaders**, pledge to make participation in our community a harassment-free experience for everyone, regardless of:
13+
Age, Body Size, Disability, Gender Identity/Expression, Nationality, Education, Sexual Orientation.
14+
We pledge to act in ways that **promote openness, respect, diversity, inclusivity, and community health.**
15+
16+
---
17+
18+
## Our Standards
19+
20+
### Positive Behaviors✅
21+
- Show empathy and kindness toward others
22+
- Respect differing opinions and experiences
23+
- Accept feedback gracefully and constructively
24+
- Own mistakes, apologize, and learn
25+
- Focus on community well-being, not just individual needs
26+
27+
---
28+
29+
### Unacceptable Behaviors🚫
30+
- Sexualized language, imagery, or advances
31+
- Trolling, insults, personal or political attacks
32+
- Harassment (public or private)
33+
- Publishing private information without consent
34+
- Any behavior considered inappropriate in a professional setting
35+
36+
---
37+
38+
## Enforcement Responsibilities
39+
40+
**Community leaders** are responsible for:
41+
- Clarifying acceptable behavior
42+
- Taking fair action against misconduct
43+
- Removing/rejecting harmful content
44+
- Communicating reasons for moderation decisions transparently
45+
46+
---
47+
48+
## Scope
49+
50+
This Code applies **everywhere**:
51+
- In community spaces
52+
- When representing the community (emails, social media, events)
53+
- Both online and offline interactions
54+
55+
---
56+
57+
## Enforcement
58+
59+
If you experience or witness misconduct:
60+
**Contact us:** [codecompass2024@gmail.com](mailto:codecompass2024@gmail.com)
61+
62+
All complaints will be handled promptly, fairly, and privately. We respect the privacy and security of all reporters.
63+
64+
---
65+
66+
## Enforcement Guidelines
67+
68+
### 1. Correction
69+
**Impact:** Inappropriate language or minor misconduct.
70+
**Consequence:** Private warning + explanation. Public apology may be requested.
71+
72+
---
73+
74+
### 2. Warning
75+
**Impact:** Violation through one or more actions.
76+
**Consequence:** Formal warning. Limited interaction for a period of time.
77+
78+
---
79+
80+
### 3. Temporary Ban
81+
**Impact:** Serious violation or repeated behavior.
82+
**Consequence:** Temporary ban from interactions and community spaces.
83+
84+
---
85+
86+
### 4. Permanent Ban
87+
**Impact:** Sustained violations or severe harassment.
88+
**Consequence:** Permanent ban from community participation.
89+
90+
---
91+
92+
## Attribution
93+
94+
This Code of Conduct is adapted from the
95+
[**Contributor Covenant**](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html) v2.0.
96+
97+
Community Impact Guidelines inspired by [Mozilla's Code of Conduct Enforcement Ladder](https://github.com/mozilla/diversity).
98+
99+
🌐 [FAQ](https://www.contributor-covenant.org/faq) | [Translations](https://www.contributor-covenant.org/translations)
100+
101+
---
102+
*Thank you for helping us create a safe and inclusive community!*

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ We welcome contributions from the community! Here's how you can contribute:
7676
2. **Clone the forked repository** to your local machine.
7777

7878
```bash
79-
git clone https://github.com/yourusername/devsetup.git
80-
cd devsetup
79+
git clone https://github.com/yourusername/DevSetup.git
80+
cd DevSetup
8181
```
8282

8383
3. **Create a new branch** for your feature or bug fix. Make sure you are working in the `dev` branch.
@@ -109,22 +109,24 @@ We welcome contributions from the community! Here's how you can contribute:
109109

110110
* **Don't forget** to sync your branch with the latest updates from the main repository to avoid merge conflicts.
111111

112-
## Troubleshooting
112+
## 🔧 Troubleshooting
113113

114-
### Tools Not Appearing
115114

115+
### Tools Not Appearing
116116
If you don’t see the new tools after adding them, ensure that you:
117117

118-
* Correctly added the tools to the `tools.xlsx` file.
119-
* Ran the `convertExcelToJson.js` script to regenerate the `tools.json` file.
120-
118+
* Ensure the tools were **correctly added** to `public/tools.xlsx`.
119+
* Run the conversion script to regenerate `tools.json`:
120+
```bash
121+
node convertExcelToJson.js
122+
```
121123
### JSON File Not Loading
122-
123124
If the app fails to load tools, check the following:
124125

125126
* Ensure the `tools.json` file is in the correct location and accessible.
126127
* Check the browser console for any errors that may point to issues with loading the JSON file.
127128

129+
128130
### Other Issues
129131

130132
Feel free to open an issue in the repository if you encounter any bugs or need assistance.

0 commit comments

Comments
 (0)