Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (65 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

94 lines (65 loc) · 2.82 KB
Raw

Contributing to RepoDoctor

Thank you for your interest in improving RepoDoctor.

RepoDoctor uses a split development model:

  • The complete analysis engine is proprietary and maintained privately by BLCCoreStudio.
  • This public repository contains approved documentation, release information, selected showcase material, and community-facing resources.

Contributing to this repository does not provide access to RepoDoctor's private implementation repository.

Contributions We Welcome

Community contributions may include:

  • Documentation improvements
  • Typo and wording fixes
  • English and Turkish translation improvements
  • Usage examples
  • Configuration examples
  • Bug reports
  • Feature requests
  • Platform compatibility reports
  • Reproduction steps for problems
  • Suggestions for usability improvements

Private Implementation

The following areas are maintained privately by BLCCoreStudio and are not part of the public contribution surface:

  • Repository analysis engine
  • Security analysis implementation
  • Autofix engine
  • GitHub intelligence implementation
  • Scoring algorithms
  • Internal tests
  • Build and release infrastructure
  • Proprietary product logic

Please do not submit reconstructed, reverse-engineered, or copied implementations of private RepoDoctor components.

Pull Requests

Before submitting a pull request:

  1. Keep the change focused.
  2. Explain what the change improves.
  3. Do not include credentials, secrets, private repository content, or personal data.
  4. Do not add executable binaries unless explicitly requested by BLCCoreStudio.
  5. Do not add dependencies or executable scripts unless the contribution has been discussed first.
  6. Verify that your changes only affect approved public repository files.

Pull requests are reviewed before merging.

Submitting a pull request does not guarantee that it will be accepted.

Security

Do not report suspected security vulnerabilities through a public issue.

Follow the instructions in SECURITY.md.

Never include:

  • Passwords
  • API keys
  • Access tokens
  • Private keys
  • Confidential source code
  • Private repository data

Malicious Contributions

BLCCoreStudio reserves the right to reject or remove contributions containing:

  • Malware
  • Credential theft
  • Backdoors
  • Obfuscated executable behavior
  • Unauthorized telemetry
  • Unexpected network communication
  • Destructive file-system operations
  • Supply-chain attacks
  • Code intended to weaken repository or release security

All contributions remain subject to maintainer review and automated validation.

Licensing

By submitting a contribution, you confirm that you have the right to provide that contribution.

Accepted contributions become part of the public RepoDoctor repository under the repository's applicable licensing terms.

Public contribution does not grant rights to RepoDoctor's proprietary implementation.