js-image-bg-remover/CONTRIBUTING.md

Fast, portable background removal using WASM and U-2-Net

# Contributing to js-image-bg-remover

First off, thank you for considering contributing to js-image-bg-remover! It's people like you that make it such a great tool.

## Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

## How Can I Contribute?

### Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

* Use a clear and descriptive title
* Describe the exact steps which reproduce the problem
* Provide specific examples to demonstrate the steps
* Describe the behavior you observed after following the steps
* Explain which behavior you expected to see instead and why
* Include sample images if relevant
* Include Node.js version and OS details

### Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

* Use a clear and descriptive title
* Provide a step-by-step description of the suggested enhancement
* Provide specific examples to demonstrate the steps
* Describe the current behavior and explain which behavior you expected to see instead
* Explain why this enhancement would be useful

### Pull Requests

* Fork the repo and create your branch from `main`
* If you've added code that should be tested, add tests
* Ensure the test suite passes
* Make sure your code lints
* Update the documentation

## Development Process

1. Clone the repository
```bash
git clone https://github.com/yourusername/js-image-bg-remover.git
cd js-image-bg-remover
```

2. Install dependencies
```bash
npm install
```

3. Run tests
```bash
npm test
```

### Project Structure

```
js-image-bg-remover/
├── index.js        # Main API implementation
├── cli.js          # CLI implementation
├── model/          # Downloaded model storage
├── scripts/        # Build and setup scripts
└── test/           # Test files
```

## Testing

* Write test cases for any new functionality
* Include both positive and negative test cases
* Test with various image types and sizes
* Test error conditions and edge cases

## Documentation

* Update README.md with details of changes to the interface
* Update API documentation if endpoints change
* Comment your code where necessary
* Update examples if needed

## License
By contributing, you agree that your contributions will be licensed under its MIT License.