Skip to content

COMMUNITY.md

Latest commit

 

History

History
197 lines (134 loc) · 5.76 KB

COMMUNITY.md

File metadata and controls

197 lines (134 loc) · 5.76 KB
Raw

Community Guidelines

Welcome to the kit community! This guide covers how to get help, report issues, request features, and contribute.

Table of Contents

Getting Help

I have a question

Before asking:

  1. Check the documentation and command reference.
  2. Search GitHub Discussions and Issues for the same question.

Where to ask:

I found a bug

Please open a GitHub Issue with:

  1. Title: clear, concise description.
  2. Description: what happened vs. what you expected.
  3. Steps to reproduce: exact steps to trigger the bug.
  4. Environment: kit version, OS, Node.js version.
  5. Logs: relevant error messages or debug output.

See the Bug Report Template below.

I need commercial support

For production support, training, or consulting, contact hello@sandstre.am.

GitHub Discussions

GitHub Discussions is the place for conversation; Issues are for tracked bugs and feature requests. Categories:

  • Q&A — usage questions and troubleshooting. Mark the answer that helped.
  • Ideas — propose and discuss features before they become issues.
  • Show and tell — share what you've built with kit.
  • General — anything else that isn't a bug or a concrete feature request.

Please search before posting, include your kit version and OS, and follow the Code of Conduct.

Reporting Issues

Bug Report Template

## Description
Brief description of the issue

## Environment
- kit version: (e.g., 4.0.0)
- Node.js version: (e.g., 22.0.0)
- OS: (e.g., macOS 14.2)
- npm/yarn version: (e.g., 10.0.0)

## Steps to Reproduce
1. Step 1
2. Step 2
3. Step 3

## Expected Behavior
What should happen

## Actual Behavior
What actually happens

## Error Messages
Paste relevant error messages or logs

## Additional Context
Any other relevant information

Issue Labels

Common labels used to categorize and track issues:

Label Meaning
bug Something is not working correctly
feature New capability or enhancement
documentation Missing or unclear documentation
security Security vulnerability or concern
performance Performance improvement needed
good first issue Good for new contributors
help wanted Maintainers seeking community help

Feature Requests

How to Request a Feature

  1. Check existing requests — search open feature issues.
  2. Open an issue — file a feature request describing the problem it solves.

Feature Request Template

## Description
Clear summary of the feature

## Problem it Solves
What problem does this solve for users?

## Proposed Solution
How should this feature work?

## Use Cases
Example scenarios where this feature would be useful

## Alternatives Considered
Other approaches or existing workarounds

## Implementation Notes
Any technical considerations or constraints

Contributing Code

Ready to contribute? See CONTRIBUTING.md for setup, development workflow, testing requirements, the pull-request process, code style, and commit conventions.

Quick Start

# Fork the repository and clone your fork
git clone https://github.com/YOUR_USERNAME/kit.git
cd kit

# Install dependencies
npm install

# Create a feature branch
git checkout -b feat/your-feature-name

# Make changes, commit, and push
git push origin feat/your-feature-name

# Open a pull request (see CONTRIBUTING.md for the checklist)

Types of Contributions We Welcome

  • Code — bug fixes, features, refactoring
  • Tests — improved coverage, edge cases
  • Documentation — guides, examples, clarifications
  • Adapters & plugins — support for more tools and ecosystems

Contributors are credited in CHANGELOG.md and on the GitHub Contributors page.

Code of Conduct

All community spaces are governed by our Code of Conduct.

  • Treat everyone with respect.
  • Harassment and discrimination are not tolerated.
  • Report violations to hello@sandstre.am.

Communication Channels

Channel Use For
GitHub Discussions Questions, ideas, showcase, general conversation
GitHub Issues Bug reports, feature requests
Email Private concerns, security, commercial support

Welcome to the kit community! 🚀