Contributing

Want to help make AppleBlox better? Here's how you can contribute.

Report Bugs

1. Check if already reported: GitHub Issues
2. Try the latest version first. The bug may already be fixed.
3. Open a new issue with the Bug Report template.
4. Include your AppleBlox version, macOS version, and steps to reproduce.
5. Attach logs from Misc > View Logs if relevant.

Suggest Features

1. Check existing feature requests on GitHub Issues.
2. Open a new issue with the Feature Request template.
3. Describe the feature, why it's useful, and provide examples or mockups if possible.

Code Contributions

1. Fork the repository on GitHub.
2. Clone your fork:

   git clone https://github.com/YourUsername/appleblox.git
   cd appleblox

3. Install dependencies:

   bun install

4. Create a branch:

   git checkout -b feature/your-feature-name

5. Make your changes following existing code style.
6. Commit using conventional commits:

   git commit -m "Add icon pack support"

7. Push and open a pull request.

Improve Documentation

• Fix typos or errors. Edit docs directly on GitHub.
• Add examples, code snippets, or configuration guides.
• Documentation files are in the docs/ directory, written in Markdown, built with VitePress.

Community

• Answer questions in Discord.
• Share mods and configurations.
• Create tutorials or videos.

Contributors are recognized on the Credits page.