claudepoint/CONTRIBUTING.md

The safest way to experiment with Claude Code. Create instant checkpoints, experiment fearlessly, restore instantly.

# Contributing to ClaudePoint

We love your input! We want to make contributing to ClaudePoint as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer

## Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

1. Fork the repo and create your branch from `main`
2. If you've added code that should be tested, add tests
3. If you've changed APIs, update the documentation
4. Ensure the test suite passes
5. Make sure your code follows the existing style
6. Issue that pull request!

## Pull Request Process

1. Update the README.md with details of changes to the interface, if applicable
2. Update the CLAUDE.md file with any new development commands or important context
3. The PR will be merged once you have the sign-off of at least one maintainer

## Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using GitHub's [issues](https://github.com/andycufari/ClaudePoint/issues)

We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/andycufari/ClaudePoint/issues/new); it's that easy!

## Write bug reports with detail, background, and sample code

**Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
  - Be specific!
  - Give sample code if you can
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

## Development Setup

```bash
# Clone your fork
git clone https://github.com/your-username/ClaudePoint.git
cd ClaudePoint

# Install dependencies
npm install

# Run in development mode
npm run dev
```

## Code Style

- Use ES modules (`import`/`export`)
- Follow existing patterns in the codebase
- Keep functions focused and single-purpose
- Add comments for complex logic
- Use meaningful variable names

## Testing

Currently, we're working on adding a comprehensive test suite. In the meantime:

- Test your changes manually
- Ensure backward compatibility
- Test on multiple platforms if possible
- Document any breaking changes

## Feature Requests

We use GitHub issues to track feature requests. Before creating a feature request:

- Check if the feature has already been requested
- Clearly describe the feature and its use case
- Explain why existing features don't solve your problem

## Community

- Star the project on GitHub
- Share your experience with ClaudePoint
- Help others in issues
- Contribute to documentation

## License

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

## Questions?

Feel free to open an issue with your question or reach out to the maintainers.

Thank you for contributing to ClaudePoint! 🎯