Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
73 lines (51 loc) 路 1.64 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) 路 1.64 KB
Raw

Contributing to krinry

Thank you for your interest in contributing to krinry! 馃帀

How to Contribute

Reporting Bugs

  1. Check if the issue already exists
  2. Create a new issue with:
    • Clear title
    • Steps to reproduce
    • Expected vs actual behavior
    • Termux version and device info

Suggesting Features

  1. Open an issue with [Feature] prefix
  2. Describe the feature and use case
  3. Explain why it would be useful

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Make your changes
  4. Test on Termux if possible
  5. Commit with clear messages
  6. Push and open a PR

Code Style

  • Use 4-space indentation in shell scripts
  • Add comments for complex logic
  • Follow existing naming conventions
  • Test your changes before submitting

Areas to Contribute

  • 馃悰 Bug fixes
  • 馃摎 Documentation improvements
  • 馃實 New features
  • 馃И Testing on different devices
  • 馃帹 UI/UX improvements

Creating an Installer Plugin

krinry uses an auto-discovery system for installers. To add a new tool (e.g. krinry install mytool):

  1. Create a new bash script at lib/installers/mytool.sh.
  2. Define a cmd_install() function inside it.
  3. Source and use shared helpers from _base.sh automatically.
  4. Commit and push: it will automatically be available to all users!

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/krinry-cli.git
cd krinry-cli

# Create symlink for testing
ln -sf $(pwd)/bin/krinry ~/.local/bin/krinry

# Test your changes
krinry --help

Questions?

Open an issue or reach out on GitHub!

Thanks for contributing! 馃殌