Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (26 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.17 KB
Raw

Contributing

Thanks for your interest in contributing to PlayDay-iOS projects.

Getting started

Most tweak repositories use Theos and build inside a container so no local iOS toolchain is needed:

docker build -t tweak-build -f Containerfile .
docker run --rm -v "$PWD:/build:Z" tweak-build

The built .deb is written to packages/.

Submitting changes

  1. Fork the repository and create a branch from main (or master).
  2. Make your changes. Keep commits focused and messages concise.
  3. Test locally with the container build above.
  4. Open a pull request with a clear description of what changed and why.

Reporting bugs

Open an issue on the relevant repository. Include:

  • Device model and iOS version.
  • Steps to reproduce.
  • Expected vs. actual behaviour.
  • Crash logs or syslog output if applicable.

Code style

  • Objective-C: follow the conventions already present in each project (Theos/Logos syntax).
  • Go (repo tool): gofmt and go vet must pass.
  • Shell: use set -euo pipefail in scripts.

License

Contributions are licensed under the same terms as the repository you contribute to (check the LICENSE file in each repo).