UNPKG

@origami-minecraft/devbuilds

Version:

Origami is a terminal-first Minecraft launcher that supports authentication, installation, and launching of Minecraft versions β€” with built-in support for Microsoft accounts, mod loaders, profile management, and more. Designed for power users, modders, an

80 lines (55 loc) β€’ 2 kB
# πŸ› οΈ Contributing to Origami First off, thank you for taking the time to contribute! πŸŽ‰ Whether you're fixing a bug, suggesting a feature, improving documentation, or just giving feedback β€” you're helping make Origami better for everyone. --- ## πŸ“Œ Ground Rules - Be respectful, helpful, and constructive. - Search [existing issues](https://github.com/merasugd/origami-launcher/issues) before opening a new one. - Use GitHub Discussions for general questions or support. - Keep PRs focused and related to a single topic. --- ## πŸ’‘ Ways to Contribute ### πŸ› Report Bugs - Use the **Bug Report** issue template. - Include clear steps to reproduce. - Attach logs and version info if applicable. ### ✨ Suggest Features - Use the **Feature Request** issue template. - Explain the problem it solves or what it improves. ### πŸ§ͺ Improve the Code - Fork the repo and make your changes on a feature branch. - Follow the existing coding style. - Write clear commit messages and reference related issues. - Test before you submit β€” manual or automated. ### πŸ“š Improve Docs - Typos, grammar fixes, better usage examples β€” all are welcome! - Feel free to update `README.md`, `CLI.md`, or add helpful wiki entries. --- ## πŸš€ Local Development Setup ```bash git clone https://github.com/merasugd/origami-launcher.git cd origami-launcher npm install npm run compile npm run origami ```` --- ## πŸ“¦ Conventions * Codebase: TypeScript (ES2020+) * Package manager: `npm` * License: GPL-3.0-only * Releases: * Stable: `@origami-minecraft/stable` * Dev: `@origami-minecraft/devbuilds` --- ## 🧼 Before You Submit a PR * Run `npm run lint` (if available) * Test your changes interactively * Ensure no breaking changes unless discussed * Add a changelog entry if relevant (`CHANGELOG.md`) --- ## ❀️ Thank You Your input powers Origami’s progress. Even small contributions make a big impact. 🌸 Let’s craft something great β€” together. β€” @merasugd