Contributing to AuriOS

Thank you for your interest in contributing to AuriOS! We welcome contributions from everyone.

How to Contribute

Install a good development environment

We use Visual Studio Code with automatic code formatting configured.

Required Setup:

Install clang-format (for C/Assembly code):
```
# macOS
brew install clang-format

# Linux (Ubuntu/Debian)
sudo apt install clang-format

# Linux (Fedora/RHEL)
sudo dnf install clang-tools-extra

# Linux (Arch)
sudo pacman -S clang
```
Install VS Code Extensions:
- clang-format - Formats C/Assembly code
How it works:
- When you press Ctrl+S (or Cmd+S on macOS), the code is automatically formatted
- clang-format formats .c and .h files (C code)
- Configuration file (.clang-format) is already in the repo
- No additional setup needed - it just works after installing the extension!
Why we do this:
- Consistent code style across the whole project
- No formatting debates in code reviews
- Clean, readable kernel code
- Automatic on save = no manual formatting needed
Fork the repository Click the "Fork" button to create your own copy.

Clone your fork

git clone https://github.com/your-username/AuriOS.git

Create a branch from Develop
```
git checkout develop
git branch -C feature/your-feature-name
```
existing cases : "feat/", "fix/", "ref/".
Make your changes Implement your feature or fix.
Commit your changes
```
git commit -m "feat: implement PMM bitmap (#12)"
```
(If you are working on an open issue, please systematically mention its number in your commit messages!)

Push to your fork

git push origin feature/your-feature-name

Open a Pull Request Go to the original repository and open a pull request to the develop branch.
Select the correct branch Please do not ask to push on AuriOS:main but on AuriOS:develop.

Please be respectful and considerate in all interactions.

Thank you for helping make AuriOS better!