We welcome contributions to ShellUI! Whether it's bug fixes, new components, documentation improvements, or feature suggestions, your help makes ShellUI better for everyone.

How to Contribute

Reporting Bugs

Found a bug? Please open an issue on GitHub with:

A clear description of the bug
Steps to reproduce
Expected vs actual behavior
Your environment (OS, .NET version, etc.)
Screenshots if applicable

Suggesting Features

Have an idea for a new feature or component? Open an issue with:

A clear description of the feature
Use cases and examples
Why this would be valuable

Contributing Code

Fork the repository

git clone https://github.com/your-username/shellui.git
cd shellui

Create a branch

git checkout -b feature/your-feature-name

Make your changes
- Follow the existing code style
- Add tests if applicable
- Update documentation
Test your changes
```
dotnet build
dotnet test
```

Commit and push

git commit -m "Add: your feature description"
git push origin feature/your-feature-name

Open a Pull Request
- Provide a clear description
- Reference any related issues
- Include screenshots for UI changes

Development Setup

Prerequisites

.NET 8.0 or higher
Node.js (for Tailwind CSS development)
Git

Getting Started

Clone the repository
Build the solution:
```
dotnet build
```
Run tests:
```
dotnet test
```

Component Development

When adding new components:

Follow the existing component structure
Use Tailwind CSS for styling
Ensure accessibility (WCAG 2.1 AA)
Add proper TypeScript/C# types
Include documentation
Add examples to the demo app

Code Style

Follow C# coding conventions
Use meaningful variable names
Add XML documentation comments
Keep components focused and composable

Documentation

When contributing documentation:

Use clear, concise language
Include code examples
Add screenshots for visual components
Keep examples up to date

Questions?

Thank you for contributing to ShellUI! 🎉

Contributing

On this page