Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (47 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

76 lines (47 loc) · 1.56 KB

Contributing to insert-tools

Thanks for your interest in contributing! We welcome all contributions — bug reports, feature suggestions, code improvements, documentation, and more.

How to Contribute

1. Fork the Repository

Click the "Fork" button in the top right corner of the repo.

2. Clone Your Fork

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

3. Create a Feature Branch

git checkout -b feature/your-feature-name

4. Make Changes and Commit

Make your changes, and commit them:

git add .
git commit -m "Add a clear message about what you changed"

5. Push to GitHub

git push origin feature/your-feature-name

6. Create a Pull Request

Go to your forked repository, click "New Pull Request", and follow the instructions.

🐛 Reporting Bugs

  • Use GitHub Issues
  • Please provide steps to reproduce, expected vs actual behavior, and environment info (OS, Python version, etc.)

💡 Feature Suggestions

Open an issue and label it with enhancement. Describe:

  • What problem this feature solves
  • How it should work

📋 Code Style

  • Use black or isort for formatting
  • Keep functions small and clear
  • Write docstrings and comments for clarity

✅ Checklist Before Submitting

  • Code compiles / runs without error
  • Tests pass (if applicable)
  • Includes documentation or examples (if needed)

Thank you for contributing 🙏