ashim/CONTRIBUTING.md
Siddharth Kumar Sah 85b1cfc10a chore: rename Stirling-Image to ashim across entire codebase
Complete rebrand from Stirling-Image to ashim following the project
move to https://github.com/ashim-hq/ashim.

Changes across 117 files:
- Package scope: @stirling-image/* → @ashim/*
- GitHub URLs: stirling-image/stirling-image → ashim-hq/ashim
- Docker Hub: stirlingimage/stirling-image → ashimhq/ashim
- GitHub Pages: stirling-image.github.io → ashim-hq.github.io
- All branding text: "Stirling Image" → "ashim"
- Docker service/volumes/user: stirling → ashim
- Database: stirling.db → ashim.db
- localStorage keys: stirling-token → ashim-token
- Environment variables: STIRLING_GPU → ASHIM_GPU
- Python cache dirs: .cache/stirling-image → .cache/ashim
- SVG filter IDs, test prefixes, and all other references
2026-04-14 20:55:42 +08:00

1.5 KiB

Contributing to ashim

Thanks for your interest in the project. Community feedback helps shape ashim, and there are several ways to get involved.

How to contribute

The best way to contribute is through GitHub Issues:

  • Bug reports - Found something broken? Open a bug report with steps to reproduce, your Docker setup, and what you expected to happen.
  • Feature requests - Have an idea for a new tool or improvement? Describe the problem you want solved and why it matters to you.
  • Feedback - Thoughts on the UI, workflow, documentation, or anything else? We want to hear it.

Pull requests

We do not accept pull requests. All development is handled internally to maintain architectural consistency and code quality across the project.

If you've found a bug, please open an issue describing it rather than submitting a fix. If you have a suggestion for how something should work, describe it in a feature request. Your input is valuable even without a code contribution.

Forking

You're welcome to fork the project for your own use under the terms of the AGPLv3 license. The Developer Guide covers setup, architecture, and how to add new tools.

Security

If you discover a security vulnerability, please report it privately through GitHub Security Advisories rather than opening a public issue.