Add the contributing section to README.md.

This commit is contained in:
Rik Heijmann 2025-02-15 22:42:53 +01:00
parent e54b589d8c
commit 609134e9e0

View File

@ -304,3 +304,73 @@ SERVER_COMPRESSION_LEVEL=6
# JWT secret key.
JWT_SECRET_KEY="Change me!"
```
## 🤝 Contributing
We welcome contributions to the Axium project! Whether it's fixing bugs, improving documentation, or adding new features, your help is greatly appreciated. Please follow these guidelines to ensure a smooth contribution process.
### 📝 How to Contribute
1. **Fork the Repository**
Start by forking the repository to your own GitHub account.
2. **Clone Your Fork**
Clone your forked repository to your local machine:
```bash
git clone https://github.com/your-username/Axium.git
cd Axium
```
3. **Create a New Branch**
Create a new branch for your feature or bug fix:
```bash
git checkout -b feature-name
```
4. **Make Your Changes**
Make the necessary changes to the code or documentation. Make sure to write tests for new features and adhere to the existing code style.
5. **Commit Your Changes**
Commit your changes with a clear, descriptive message:
```bash
git commit -m "Add feature XYZ or fix issue ABC"
```
6. **Push to Your Fork**
Push your changes to your fork:
```bash
git push origin feature-name
```
7. **Open a Pull Request**
Open a pull request against the `main` branch of the original repository. In the description, provide details about the changes you made, the problem they solve, and any testing you performed.
### 🔍 Code Style
- Follow the **Rust style guidelines** outlined in the [Rust Style Guide](https://doc.rust-lang.org/1.0.0/style/).
- Use **cargo fmt** to automatically format your code:
```bash
cargo fmt
```
- Write **meaningful commit messages** that describe the changes you've made.
### 🛠️ Reporting Bugs
If you encounter a bug or issue, please check if it has already been reported in the [GitHub issues](https://github.com/Riktastic/Axium/issues). If not, create a new issue, providing the following information:
- A clear description of the problem.
- Steps to reproduce the issue.
- Expected vs. actual behavior.
- Any relevant logs or error messages.
### 💬 Discussion
Feel free to open discussions in the [Discussions](https://github.com/Riktastic/Axium/discussions) section for general questions, ideas, or advice on how to improve the project.
### 🧑‍💻 Code of Conduct
Please be respectful and follow the [Code of Conduct](https://www.contributor-covenant.org/) while interacting with other contributors. Let's maintain a positive and welcoming environment.
### 🎉 Thanks for Contributing!
Your contributions help make Axium better for everyone! 🙏