45 lines
960 B
Markdown
45 lines
960 B
Markdown
# Contributing to kv-pix
|
|
|
|
We welcome contributions to kv-pix!
|
|
|
|
## Getting Started
|
|
|
|
1. **Fork** the repository.
|
|
2. **Clone** your fork:
|
|
```bash
|
|
git clone https://github.com/your-username/kv-pix.git
|
|
cd kv-pix
|
|
```
|
|
3. **Install dependencies**:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
## Development Flow
|
|
|
|
1. Create a new branch for your feature or fix:
|
|
```bash
|
|
git checkout -b feature/my-new-feature
|
|
```
|
|
2. Make your changes.
|
|
3. Run linting to ensure code quality:
|
|
```bash
|
|
npm run lint
|
|
```
|
|
4. (Optional) Run build to check for errors:
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## Commit Guidelines
|
|
|
|
- Use clear and descriptive commit messages.
|
|
- Mention relevant issue numbers if applicable.
|
|
|
|
## Pull Requests
|
|
|
|
1. Push your branch to GitHub.
|
|
2. Open a Pull Request against the `main` branch.
|
|
3. Describe your changes and why they are needed.
|
|
|
|
Thank you for contributing!
|