103 lines (65 loc) · 1.88 KB

Contributing to Insert Tools

🎉 Thanks for taking the time to contribute to insert-tools!

We welcome contributions of all kinds — new features, bug fixes, documentation, tests, or feedback. Here's how to get started.

🛠️ Setting up the project locally

Fork the repository on GitHub

Clone your fork:

git clone https://github.com/your-username/insert-tools.git
cd insert-tools

Install dependencies:
```
pip install -r requirements.txt
```
Try the CLI:
```
python clickhouse_insert/cli.py --help
```

📁 Project structure

clickhouse_insert/ – main CLI logic and insert functionality
tests/ – unit tests
examples/ – example configs or use cases
README.md – overview and usage instructions

🧪 Running tests

We use pytest for testing:

pytest tests/

Make sure your feature or fix includes a test case if applicable.

💬 Making changes

Create a new branch:
```
git checkout -b your-feature-name
```
Make your changes
Commit your work:
```
git commit -m "feat: short description of your change"
```
Example prefixes:
- feat: – new feature
- fix: – bug fix
- test: – test related changes
- docs: – documentation only
Push and open a pull request:
```
git push origin your-feature-name
```

✨ Suggesting features or reporting issues

We love ideas! Feel free to open an issue for:

Feature requests
Bugs
Usability suggestions

✅ Code of Conduct

This project follows a Code of Conduct. By participating, you agree to uphold these standards.

📫 Contact

For questions or discussions, open a GitHub issue or reach out via Discussions tab.

Happy coding! 🚀