Submitting a PR

Contributions are welcome. Here’s how to get a pull request merged smoothly.

Before you start

For anything beyond a small bug fix, open an issue first to discuss the change. This avoids wasted effort if the direction doesn’t fit the project.

Workflow

1. Fork the repository on GitHub
2. Create a branch: git checkout -b your-feature-name
3. Make your changes
4. Test locally with npm run tauri dev
5. Commit with a clear message describing why, not just what
6. Push and open a PR against the dev branch

PR checklist

• Tested on macOS with both Apple Silicon and Intel if possible
• No new dependencies added without discussion
• UI changes include a screenshot or short video in the PR description
• Commit messages are clear and descriptive

Code style

Needle uses ESLint and Prettier. Run npm run lint before submitting. The CI will check this too.

Questions

Open a GitHub Discussion ↗ if you’re unsure about anything before diving in.