@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
Markdown
# π οΈ 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