Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (54 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

85 lines (54 loc) · 2.21 KB

Contributing to BinaryFetch

Thank you for your interest in BinaryFetch.

BinaryFetch is an open-source project developed under the BinaryFetch-CLI organization, with a strong focus on architectural clarity, stability, and long-term maintainability.

Please read this document carefully before contributing.

Development Model

BinaryFetch follows a maintainer-driven, phase-based development model.

This means:

  • The source code is open and publicly available.
  • Development priorities are defined by the core maintainers.
  • Contributions are accepted only if they align with the current development focus.

This approach prevents architectural drift and ensures consistent, intentional growth.

Platform Status

BinaryFetch targets Windows only. The Windows version has been released and its core architecture is considered stable.

Accepted Contributions

  • Bug fixes
  • Stability improvements
  • Minor refinements
  • Regression fixes
  • Documentation updates
  • Issues and discussions aligned with the roadmap

Not Accepted (without explicit approval)

  • Large refactors
  • Major architectural changes
  • Feature expansions outside the roadmap
  • Platform expansions (Linux, macOS, etc.)
  • Random module additions

Well-written code may still be declined if it is out of scope.

Issues Before Pull Requests

Pull requests must be linked to an approved issue.

Workflow

  1. Review the current roadmap and open issues
  2. Pick an existing issue or open a new issue describing your proposal
  3. Wait for maintainer approval before starting work

Unlinked or unsolicited PRs may be closed without review.

Pull Request Guidelines

  • Target the appropriate branch as specified by maintainers
  • Keep PRs focused and minimal
  • Follow the existing coding style
  • Avoid unrelated changes in the same PR
  • Write clear and descriptive commit messages

Maintainers reserve the right to request changes or decline PRs.

Forks and Attribution

Forking BinaryFetch is allowed under the project license.

However:

  • The project name must not be misrepresented
  • Original authorship and license information must remain intact
  • Forks must not claim to be the original BinaryFetch project