Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (37 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 1.2 KB
Raw

Contributing to OpenFix

Thank you for your interest in contributing to OpenFix! 🎉

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/openfix.git
  3. Install dependencies: pip install -r requirements.txt
  4. Create a branch: git checkout -b feature/your-feature-name

Development Guidelines

Code Style

  • Follow PEP 8
  • Use type hints for function signatures
  • Run black for formatting: black .
  • Run isort for imports: isort .

Testing

  • Write tests for new features
  • Ensure all tests pass: pytest tests/
  • Aim for >80% code coverage

Commit Messages

Use conventional commits format:

feat: add new feature
fix: resolve bug 
docs: update README
test: add unit tests
refactor: improve code structure

Pull Requests

  1. Update documentation if needed
  2. Add tests for new functionality
  3. Ensure CI passes
  4. Link related issues
  5. Request review from maintainers

Code of Conduct

Be respectful, inclusive, and professional. See full Code of Conduct.

Questions?

Open a discussion or reach out via issues.

Happy coding! 🚀