Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (43 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 2.68 KB
Raw

Contributing

Thank you for contributing to Horosa for Windows.

Before you open an issue

  • Use GitHub Discussions for general usage questions
  • Use GitHub Issues for confirmed bugs, regressions, or scoped feature requests
  • Include the module, platform, version, and reproduction steps whenever possible

Pull request workflow

  1. Sync from main
  2. Create a focused branch, preferably codex/<topic> or feature/<topic>
  3. Keep the scope limited and explain affected modules clearly
  4. Run the minimum local checks before opening the PR
  5. Update docs when behavior, contracts, or release-facing flows change

Minimum checks before submitting

The full product source ships under local/workspace/Horosa-Web-…/. For a frontend change, build + test from its workspace:

cd local/workspace/Horosa-Web-55c75c5b088252fbd718afeffa6d5bcb59254a0c/astrostudyui
npm ci
npm run build:file

For docs / governance / prepareruntime/ / windows-adaptations/ changes, verify links and relative paths still resolve. (The desktop packaging project — Electron + NSIS — is maintained privately and is not part of this repo.)

Required doc sync

If your change touches any of the following, update the matching docs in the same PR:

  • README / onboarding / release-facing behavior
  • License or repository governance files
  • API contracts or provider compatibility notes
  • AIAnalysis data model, backup format, workspace migration, or export format

AIAnalysis-specific rules

If a change affects AIAnalysis, you must also update:

  • the README feature description
  • release notes or release body draft
  • any relevant migration or compatibility note

If a change affects provider behavior, storage schema, or backup / restore format, call out:

  • migration risk
  • compatibility impact on existing workspaces
  • whether exported backups remain forward / backward compatible

Commit style

Small, reviewable commits are preferred. Use imperative commit subjects, for example:

  • Add Windows AIAnalysis backup zip support
  • Fix AIAnalysis layout gap under default scale

Licensing Note

Horosa is now on an explicit AGPL-3.0 open-source release track. The repository-level license is AGPL-3.0. This change is aligned with the public release stack that integrates Swiss Ephemeris / pyswisseph. Third-party subdirectories may continue to carry their own original upstream notices, so do not overwrite those files when preparing contributions.

Security

Do not open public issues for security-sensitive findings. Follow SECURITY.md instead.