Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (49 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

72 lines (49 loc) · 1.33 KB
Raw

Contributing to RazBuild

Thank you for your interest in contributing to RazBuild projects.

Before You Start

  • Check existing issues before opening a new one.
  • Use the provided issue templates.
  • Keep discussions respectful and constructive.

Reporting Bugs

Please include:

  • Project name and version
  • Operating system
  • Python version (if applicable)
  • Steps to reproduce
  • Expected behavior
  • Actual behavior

Development

Each project may have its own setup instructions and architecture.

Please refer to the project's README and documentation for:

  • Installation
  • Development environment setup
  • Testing
  • Project structure

Code Quality

Before submitting a Pull Request:

  • Run tests
  • Run linters and formatters
  • Update documentation when needed
  • Add tests for new functionality

Commit Messages

Use conventional prefixes:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation
  • test: Tests
  • refactor: Refactoring
  • chore: Maintenance

Example:

feat: add local model discovery
fix: handle invalid configuration file

Pull Requests

  1. Create a feature or fix branch.
  2. Make your changes.
  3. Ensure quality checks pass.
  4. Open a Pull Request.
  5. Describe your changes clearly.

Questions

If you are unsure about something, open an issue and ask.

Thank you for helping improve RazBuild.