Skip to content

Commit b214f22

Browse files
authored
Merge pull request #4 from Roshanjossey/main
add issue, pull request templates and contributing guide
2 parents 69125d9 + 461c3dd commit b214f22

File tree

5 files changed

+155
-0
lines changed

5 files changed

+155
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing to devicon.dev
2+
3+
Thank you for your interest in contributing! We welcome all kinds of contributions, including bug reports, feature requests, documentation improvements, and code changes.
4+
5+
## How to Contribute
6+
7+
1. **Fork the repository** and create your branch from `main`.
8+
2. **Open an issue** to discuss your proposed changes if it’s a major feature or change.
9+
3. **Make your changes** with clear, descriptive commit messages.
10+
4. **Test your changes** to ensure they work as expected.
11+
5. **Open a pull request** and fill out the PR template.
12+
13+
## Code Style
14+
- Follow the existing code style and formatting.
15+
- Use clear and descriptive names for variables, functions, and components.
16+
17+
## Reporting Bugs
18+
- Use the Bug Report issue template.
19+
- Provide as much detail as possible, including steps to reproduce and environment information.
20+
21+
## Suggesting Features
22+
- Use the Feature Request issue template.
23+
- Explain the motivation and possible solutions.
24+
25+
## Questions or Discussions
26+
- Use the Other Issue template for questions or general discussions.
27+
28+
## Code of Conduct
29+
Please be respectful and considerate in all interactions.
30+
31+
---
32+
Thank you for helping make devicon.dev better!

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: "Bug Report"
2+
description: "Report a reproducible error or unexpected behavior."
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Bug Report
9+
Please provide as much detail as possible to help us reproduce the issue.
10+
- type: input
11+
id: summary
12+
attributes:
13+
label: "Summary"
14+
description: "Briefly describe the bug."
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: steps
19+
attributes:
20+
label: "Steps to Reproduce"
21+
description: "List the steps to reproduce the bug."
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: expected
26+
attributes:
27+
label: "Expected Behavior"
28+
description: "What did you expect to happen?"
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: actual
33+
attributes:
34+
label: "Actual Behavior"
35+
description: "What actually happened?"
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: environment
40+
attributes:
41+
label: "Environment"
42+
description: "Please provide information about your environment (OS, browser, etc.)."
43+
validations:
44+
required: false

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: "Feature Request"
2+
description: "Suggest a new feature or improvement."
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Feature Request
9+
Thank you for suggesting a new feature or improvement!
10+
- type: input
11+
id: summary
12+
attributes:
13+
label: "Summary"
14+
description: "Briefly describe the feature or improvement."
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: motivation
19+
attributes:
20+
label: "Motivation"
21+
description: "Why is this feature important? What problem does it solve?"
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: proposal
26+
attributes:
27+
label: "Proposed Solution"
28+
description: "Describe your proposed solution or approach."
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: "Alternatives"
35+
description: "Have you considered any alternatives?"
36+
validations:
37+
required: false

.github/ISSUE_TEMPLATE/other.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "Other Issue"
2+
description: "Questions, discussions, or anything that doesn’t fit the other templates."
3+
labels: [question]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Other Issue
9+
For questions, discussions, or anything else.
10+
- type: input
11+
id: summary
12+
attributes:
13+
label: "Summary"
14+
description: "Briefly describe your issue or question."
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: details
19+
attributes:
20+
label: "Details"
21+
description: "Provide any additional details or context."
22+
validations:
23+
required: false

.github/pull_request_template.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Pull Request
2+
3+
Thank you for your contribution!
4+
5+
### Description
6+
<!-- Please describe your changes in detail. -->
7+
8+
### Related Issue
9+
<!-- If this PR addresses an issue, please link it here. -->
10+
11+
### Checklist
12+
- [ ] I have read the [contributing guidelines](../CONTRIBUTING.md) (if available)
13+
- [ ] My code follows the code style of this project
14+
- [ ] I have added tests where applicable
15+
- [ ] I have updated documentation where applicable
16+
- [ ] All new and existing tests passed
17+
18+
### Additional Notes
19+
<!-- Add any other context or screenshots about the PR here. -->

0 commit comments

Comments
 (0)