zaneyos/CONTRIBUTING.md
2025-08-07 07:54:53 -04:00

81 lines
2.8 KiB
Markdown

# 💖 Contributing to ZaneyOS
We're excited that you're interested in contributing to ZaneyOS! Your help is
essential for keeping it great.
This document is a guide to help you through the process of contributing to
ZaneyOS. We are a welcoming and friendly community, and we are happy to help you
get started.
## 📜 Code of Conduct
We have a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect all contributors
to adhere to. Please take a moment to read it before you start contributing.
## 🚀 How to Contribute
There are many ways to contribute to ZaneyOS, from writing code to reporting
bugs and suggesting new features.
### 🐛 Reporting Bugs
If you find a bug, please open an issue on our [issue tracker](../../issues).
When you report a bug, please include the following:
- A clear and descriptive title.
- A detailed description of the bug, including steps to reproduce it.
- Your environment details (OS, ZaneyOS version, etc.).
- Any relevant logs or screenshots.
### ✨ Suggesting Enhancements
If you have an idea for a new feature or an enhancement to an existing one,
please open an issue on our [issue tracker](../../issues).
When you suggest an enhancement, please include the following:
- A clear and descriptive title.
- A detailed description of the enhancement, including the problem it solves and
why it would be a good addition to ZaneyOS.
- Any relevant mockups or screenshots.
### 💻 Code Contributions
If you want to contribute code to ZaneyOS, please follow these steps:
1. **Fork the repository** and clone it to your local machine.
2. **Create a new branch** for your changes: `git checkout -b your-branch-name`
3. **Make your changes** and commit them with a clear and descriptive commit
message.
4. **Push your changes** to your fork: `git push origin your-branch-name`
5. **Open a pull request** to the `main` branch of the ZaneyOS repository.
When you open a pull request, please include the following:
- A clear and descriptive title.
- A detailed description of the changes, including the problem it solves and how
you solved it.
- Any relevant issue numbers.
## 🎨 Style Guide
We have a style guide that we expect all contributors to follow. Please take a
moment to read it before you start contributing.
- **Git Commit Messages:** We use the
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
specification for our commit messages.
- **Code Style:** We use `shfmt` to format our shell scripts. Please make sure
your code is formatted before you open a pull request.
## 💬 Community
If you have any questions or want to get in touch with the community, you can
find us on:
- **Discord:** [Join our Discord server](https://discord.gg/CHZzESXs)
- **Twitter:** [@ZaneyOS](https://twitter.com/ZaneyOS)
We are happy to help you get started with contributing to ZaneyOS. We look
forward to your contributions!