Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (38 loc) · 4.33 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 4.33 KB

Contributing to GitGalaxy

First off, thank you for considering contributing to GitGalaxy! The blAST engine is essentially a tunable scientific instrument, and calibrating it across the vast ecosystem of open-source software requires a community effort.

Whether you are reporting a taxonomic discrepancy, refining the parsing engine, or expanding the documentation, your input helps map the structural DNA of software more accurately.

🧬 The blAST Philosophy

Before diving in, please remember that GitGalaxy treats code as a living organism. The blAST engine evaluates structural logic and behavioral genetic markers, not just rigid syntax.

Sometimes, what appears to be a traditional parsing error might actually be blAST intentionally flagging a structural anomaly or a dense risk exposure. Please keep this in mind when reporting issues or proposing changes to the sequencing algorithms.

🔬 The Differential Scan (How We Review Pull Requests)

We do not merge structural backend changes based solely on subjective code review. GitGalaxy operates at hyper-scale, and every change to the parsing logic has cascading effects.

When you submit a Pull Request that alters the blAST engine, your candidate changes will be subjected to a Full Differential Scan.

  • The Control + Variable Test: We run your branch against our calibrated baseline of ~80 massive open-source repositories, plus the specific repository your PR is designed to address.
  • Before and After: We perform a strict comparison of the engine's output before and after your rule update across this entire dataset (80 + 1). This ensures your addition resolves the target discrepancy without degrading the established baseline.
  • The Metrics: The output is assessed strictly on four vectors: Accuracy, Speed, Utility, and Ethos.
  • Only changes that are mathematically and practically measurably better across the broader ecosystem will be incorporated.

🛠️ Submitting Pull Requests

To ensure your contribution integrates smoothly into the blAST ecosystem:

  1. Fork and Branch: Create a feature branch from main (git checkout -b feature/your-feature-name).
  2. Maintain the Contract: Ensure that any backend changes to the CLI do not break the universal JSON contract expected by the frontend Observatory.
  3. Test Visually: Run your newly generated _galaxy.json through either GitGalaxy.io or your local Airgap Observatory to verify that visual rendering and flexbox constraints remain intact. Whichever is more convenient for you is fine.
  4. Document: If you are adding new language phenotypes or altering the parsing logic, please update the Taxonomical Equivalence Map in the wiki.
  5. Submit: Open a PR with a clear title. Explain the why behind your structural changes, not just the what. Be sure to include the link to the target repository so we can include it in the Differential Scan.

🐛 Reporting Discrepancies

If the galaxyscope misidentifies a repository's structure or fails to parse a specific file phenotype, please use our Parsing Discrepancy Form.

To help us reproduce the issue with quantitative precision, you will be asked to provide:

  • A direct link to the public repository being scanned.
  • The Observatory viewer you were using (GitGalaxy.io or Airgap Observatory).
  • A clear description of the expected vs. actual output.
  • The contents of your custom standards.py file (if applicable).
  • Contact information for follow-up questions.

🛡️ Security Vulnerabilities

If you discover a vulnerability within GitGalaxy itself (e.g., a way to bypass the local sandbox or an issue in the Airgap Observatory), do not open a public issue. Please reach out directly via the contact portal at GitGalaxy.io so the vulnerability can be patched securely before public disclosure.

📜 Licensing Reminder

GitGalaxy is released under the PolyForm Noncommercial License 1.0.0. By contributing to this repository, you agree that your contributions will be licensed under these same terms.

Note: This tool is free for research, education, testing, and hobby projects. Any commercial use or integration into commercial SaaS products or corporate CI/CD pipelines requires a separate commercial license.