Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (28 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.2 KB

Contributing to BlackRoad OS

Thank you for your interest in contributing.

Getting Started

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Submit a pull request

Pull Request Guidelines

  • Keep PRs focused on a single change
  • Write clear commit messages explaining why, not just what
  • Ensure your branch is up to date with main before submitting
  • All PRs to main/master require review (enterprise policy)

Branch Naming

  • feature/description — new functionality
  • fix/description — bug fixes
  • docs/description — documentation changes

Code Standards

  • Follow existing code style in the repository
  • Add tests for new functionality where applicable
  • Do not commit secrets, credentials, or environment files

Reporting Issues

  • Use the repository's issue templates when available
  • Include steps to reproduce for bug reports
  • Check existing issues before creating duplicates

License

By contributing, you agree that your contributions will be licensed under the repository's existing license. BlackRoad OS repositories use a proprietary license unless otherwise stated.

Questions?

Open a discussion or reach out at hello@blackroad.io.