Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: Bug Report
description: Report a bug or issue with a component or utility
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug! Please fill out the information below.

- type: dropdown
id: component-type
attributes:
label: Component Type
description: Which type of component is affected?
options:
- Code Block Component
- Block (multi-tab, package manager, etc.)
- Utility (Shiki, Sugar-High)
- Documentation
- Other
validations:
required: true

- type: input
id: component-name
attributes:
label: Component/Utility Name
description: Name of the specific component or utility
placeholder: code-block, copy-button, shiki-highlighter
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Clear description of the bug
placeholder: The component doesn't render when...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: How can we reproduce this issue?
placeholder: |
1. Import the component
2. Pass props with...
3. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What should happen?
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happens?
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Your environment details
value: |
- OS:
- Browser:
- Node version:
- Next.js version:
render: markdown
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional Context
description: Screenshots, error messages, or other relevant information
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://code-blocks.pheralb.dev
about: Check the documentation for usage guides and examples
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Feature Request
description: Suggest a new component, utility, or feature
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! Please provide details below.

- type: dropdown
id: feature-type
attributes:
label: Feature Type
description: What type of feature are you requesting?
options:
- New Component
- New Block
- New Utility
- Component Enhancement
- Documentation
- Other
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Clear description of the feature
placeholder: I'd like to see a component that...
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: How would this feature be used?
placeholder: This would be useful for...
validations:
required: true

- type: textarea
id: examples
attributes:
label: Examples
description: Links to similar implementations or mockups
placeholder: |
- https://example.com/component
- [Attach mockup images]

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other information about the feature
36 changes: 36 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Code of Conduct

## Our Pledge

We are committed to providing a welcoming and inclusive environment for everyone contributing to code-blocks, regardless of experience level, background, or identity.

## Our Standards

Positive behavior includes:

- Using welcoming and inclusive language
- Respecting differing viewpoints and experiences
- Accepting constructive feedback gracefully
- Focusing on what's best for the community
- Showing empathy towards other community members

Unacceptable behavior includes:

- Harassment, trolling, or discriminatory comments
- Personal or political attacks
- Publishing others' private information without permission
- Any conduct that would be inappropriate in a professional setting

## Scope

This Code of Conduct applies to all project spaces, including GitHub issues, pull requests, discussions, and any other community interactions.

## Enforcement

Instances of unacceptable behavior may be reported to the project maintainers. All complaints will be reviewed and investigated promptly and fairly.

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.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@

## Contributing

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).
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).

### Development Setup

Expand Down