Skip to content

Commit 0eef73a

Browse files
uvenkatatejauvenkatateja
committed
docs: add code of conduct and github templates
1 parent c30704f commit 0eef73a

5 files changed

Lines changed: 186 additions & 1 deletion

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: Bug Report
2+
description: Report a bug or issue with a component or utility
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for reporting a bug! Please fill out the information below.
9+
10+
- type: dropdown
11+
id: component-type
12+
attributes:
13+
label: Component Type
14+
description: Which type of component is affected?
15+
options:
16+
- Code Block Component
17+
- Block (multi-tab, package manager, etc.)
18+
- Utility (Shiki, Sugar-High)
19+
- Documentation
20+
- Other
21+
validations:
22+
required: true
23+
24+
- type: input
25+
id: component-name
26+
attributes:
27+
label: Component/Utility Name
28+
description: Name of the specific component or utility
29+
placeholder: code-block, copy-button, shiki-highlighter
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: description
35+
attributes:
36+
label: Description
37+
description: Clear description of the bug
38+
placeholder: The component doesn't render when...
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: reproduction
44+
attributes:
45+
label: Steps to Reproduce
46+
description: How can we reproduce this issue?
47+
placeholder: |
48+
1. Import the component
49+
2. Pass props with...
50+
3. See error
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: expected
56+
attributes:
57+
label: Expected Behavior
58+
description: What should happen?
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: actual
64+
attributes:
65+
label: Actual Behavior
66+
description: What actually happens?
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: environment
72+
attributes:
73+
label: Environment
74+
description: Your environment details
75+
value: |
76+
- OS:
77+
- Browser:
78+
- Node version:
79+
- Next.js version:
80+
render: markdown
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
id: additional
86+
attributes:
87+
label: Additional Context
88+
description: Screenshots, error messages, or other relevant information

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Documentation
4+
url: https://code-blocks.pheralb.dev
5+
about: Check the documentation for usage guides and examples

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Feature Request
2+
description: Suggest a new component, utility, or feature
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for suggesting a feature! Please provide details below.
9+
10+
- type: dropdown
11+
id: feature-type
12+
attributes:
13+
label: Feature Type
14+
description: What type of feature are you requesting?
15+
options:
16+
- New Component
17+
- New Block
18+
- New Utility
19+
- Component Enhancement
20+
- Documentation
21+
- Other
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: Clear description of the feature
30+
placeholder: I'd like to see a component that...
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: use-case
36+
attributes:
37+
label: Use Case
38+
description: How would this feature be used?
39+
placeholder: This would be useful for...
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: examples
45+
attributes:
46+
label: Examples
47+
description: Links to similar implementations or mockups
48+
placeholder: |
49+
- https://example.com/component
50+
- [Attach mockup images]
51+
52+
- type: textarea
53+
id: additional
54+
attributes:
55+
label: Additional Context
56+
description: Any other information about the feature

‎CODE_OF_CONDUCT.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We are committed to providing a welcoming and inclusive environment for everyone contributing to code-blocks, regardless of experience level, background, or identity.
6+
7+
## Our Standards
8+
9+
Positive behavior includes:
10+
11+
- Using welcoming and inclusive language
12+
- Respecting differing viewpoints and experiences
13+
- Accepting constructive feedback gracefully
14+
- Focusing on what's best for the community
15+
- Showing empathy towards other community members
16+
17+
Unacceptable behavior includes:
18+
19+
- Harassment, trolling, or discriminatory comments
20+
- Personal or political attacks
21+
- Publishing others' private information without permission
22+
- Any conduct that would be inappropriate in a professional setting
23+
24+
## Scope
25+
26+
This Code of Conduct applies to all project spaces, including GitHub issues, pull requests, discussions, and any other community interactions.
27+
28+
## Enforcement
29+
30+
Instances of unacceptable behavior may be reported to the project maintainers. All complaints will be reviewed and investigated promptly and fairly.
31+
32+
Project maintainers have the right to remove, edit, or reject comments, commits, code, issues, and other contributions that do not align with this Code of Conduct.
33+
34+
## Attribution
35+
36+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252

5353
## Contributing
5454

55-
We welcome contributions to enhance the functionality, design, and documentation of this project. To contribute, please read our [Contributing Guide](https://github.com/pheralb/code-blocks/blob/main/CONTRIBUTING.md).
55+
We welcome contributions to enhance the functionality, design, and documentation of this project. To contribute, please read our [Contributing Guide](https://github.com/pheralb/code-blocks/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/pheralb/code-blocks/blob/main/CODE_OF_CONDUCT.md).
5656

5757
### Development Setup
5858

0 commit comments

Comments
 (0)