Contributing

Contributions to KiLM are welcome! Whether it’s reporting bugs, suggesting features, improving documentation, or submitting code changes, your help is appreciated.

Reporting Issues

Search Existing Issues: Before creating a new issue, please check if a similar one already exists on the GitHub Issues page.
Provide Details: If creating a new issue, please include:
- KiLM version (kilm --version)
- KiCad version
- Operating System
- Clear description of the bug or feature request
- Steps to reproduce the issue (for bugs)
- Any relevant error messages or logs (use --verbose flag if applicable)

Submitting Changes (Pull Requests)

Fork the Repository: Create your own fork of the KiLM repository on GitHub.
Clone Your Fork: Clone your forked repository to your local machine.
Terminal window
```
git clone https://github.com/YOUR_USERNAME/kilm.git
cd kilm
```
Set up Development Environment: Follow the Development Setup guide to install dependencies in a virtual environment.
Create a Feature Branch: Create a new branch for your changes.
Terminal window
```
git checkout -b feature/my-amazing-feature  # Or fix/issue-number
```
Make Your Changes: Implement your feature or bug fix.
Add Tests: If adding a new feature or fixing a bug, please add corresponding tests in the tests/ directory.
Format Code: Ensure your code is formatted using Black.
Terminal window
```
black .
```
Run Tests: Make sure all tests pass.
Terminal window
```
pytest
```
Commit Changes: Commit your changes with a clear and descriptive commit message.
Terminal window
```
git add .
git commit -m "feat: Add support for XYZ feature"
```
Push to Your Fork: Push your feature branch to your fork on GitHub.
Terminal window
```
git push origin feature/my-amazing-feature
```
Open a Pull Request: Go to the original KiLM repository on GitHub and open a Pull Request (PR) from your feature branch to the main branch of the upstream repository.
- Provide a clear description of your changes in the PR.
- Link to any relevant issues (e.g., “Closes #123”).

Code Style

Follow PEP 8 guidelines.
Use Black for code formatting.
Write clear and concise code with comments where necessary.

Thank you for contributing!