Skip to content
Merged
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
68 changes: 68 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Contributing to envui

Thank you for your interest in contributing to envui. All contributions are welcome.

## How to Contribute

For significant changes, please open an issue first to discuss your proposed changes. This helps ensure alignment with project goals and prevents duplicate efforts.

## Development Process

### Getting Started

1. Fork the repository
2. Clone your fork: `git clone https://github.com/your-username/envui.git`
3. Create a feature branch from `develop`: `git checkout -b feature/your-feature develop`
4. Make your changes
5. Push to your fork: `git push origin feature/your-feature`
6. Open a Pull Request against the `develop` branch

### Commit Messages

Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:

Comment thread
flowernotfound marked this conversation as resolved.
### Pull Requests

Keep pull requests small and focused. Each PR should represent a single logical change. Split large changes into multiple PRs when possible.

## Development Setup

### Prerequisites

- Node.js 18 or higher
- pnpm package manager

### Installation

```bash
pnpm install
```

### Running Tests

```bash
pnpm test
```

### Building

```bash
pnpm build
```

### Linting and Formatting

```bash
pnpm lint
pnpm lint:fix
pnpm format
pnpm typecheck
```

## Questions and Support

If you have questions or need clarification, please open an issue. We aim to respond promptly to all inquiries.

## License

By contributing to envui, you agree that your contributions will be licensed under the MIT License.