docs: update readme

Author: draphy

CONTRIBUTING.md

@@ -0,0 +1,213 @@
+# Contributing to draphyOS
+
+Thank you for your interest in contributing to draphyOS! This document provides guidelines and instructions for contributing to this project.
+
+## Code of Conduct
+
+By participating in this project, you agree to be respectful and create a harassment-free experience for everyone.
+
+## Contribution Workflow
+
+We follow a structured workflow for all contributions. Here's the process:
+
+### 1. Create an Issue
+
+- Before making any changes, start by creating an issue in the [GitHub issue tracker](https://github.com/draphy/draphyOS/issues)
+- Clearly describe the bug, feature, or improvement you want to address
+- Wait for a DRO issue number to be assigned in the comments
+
+> **Note:** Small fixes (typos, minor docs) can skip this step — just open a PR directly.
+
+### 2. Branch Naming Convention
+
+Create a branch with the following naming format:
+
+```
+username/dro-<issue-number>-<issue-title>
+```
+
+Example:
+
+```
+johndoe/dro-123-fix-battery-detection
+janedoe/dro-45-add-bluetooth-module
+```
+
+### 3. Fork and Clone the Repository
+
+- Fork the repository to your GitHub account
+- Clone your fork to your local machine
+- Add the upstream repository as a remote
+
+```bash
+git clone https://github.com/YOUR_USERNAME/draphyOS.git
+cd draphyOS
+git remote add upstream https://github.com/draphy/draphyOS.git
+```
+
+### 4. Set Up the Development Environment
+
+```bash
+# Ensure you have shellcheck installed
+sudo dnf install ShellCheck
+
+# Validate scripts
+shellcheck install.sh uninstall.sh
+
+# Check bash syntax
+bash -n install.sh
+bash -n uninstall.sh
+```
+
+### 5. Make Your Changes
+
+- Create a new branch with the proper naming convention
+- Make your changes following the coding conventions
+- Update documentation if necessary
+
+**What you can modify:**
+- **Configs**: Edit files in `configs/`
+- **Scripts**: Modify `install.sh`, `uninstall.sh`
+- **Docs**: Update `README.md`, `CONTRIBUTING.md`
+
+### 6. Commit Guidelines
+
+We use [Conventional Commits](https://www.conventionalcommits.org/) for clear and meaningful commit messages.
+
+Format:
+
+```
+<type>: <description>
+```
+
+Where `type` is one of:
+
+| Type       | Description                    |
+| ---------- | ------------------------------ |
+| `feat`     | A new feature                  |
+| `fix`      | A bug fix                      |
+| `docs`     | Documentation changes          |
+| `style`    | Formatting, no code change     |
+| `refactor` | Code refactoring               |
+| `perf`     | Performance improvements       |
+| `test`     | Adding or updating tests       |
+| `build`    | Build system changes           |
+| `ci`       | CI configuration changes       |
+| `chore`    | Maintenance tasks              |
+| `revert`   | Reverting changes              |
+
+Example:
+
+```bash
+git commit -m "feat: add network speed display to polybar"
+git commit -m "fix: correct battery detection on desktops"
+git commit -m "docs: update installation instructions"
+```
+
+### 7. Pull Request Process
+
+0. Before pushing, run the full local check to ensure CI will pass:
+
+   ```bash
+   # Lint shell scripts
+   shellcheck install.sh uninstall.sh
+
+   # Check bash syntax
+   bash -n install.sh
+   bash -n uninstall.sh
+   ```
+
+1. Push your changes to your fork
+2. Create a pull request against the `latest` branch
+3. Use this format for the PR title:
+   ```
+   <type>: <Description starting with capital letter>
+   ```
+   Example:
+   ```
+   feat: Add network speed display to polybar
+   fix: Correct battery detection on desktops
+   docs: Update installation instructions
+   ```
+4. Provide a detailed description in the PR
+5. Link the PR to the relevant issue
+6. Ensure all status checks pass
+7. Request a review from maintainers
+
+Pull requests require approval before they can be merged.
+
+**PR Title Examples:**
+
+| ✅ Valid                                      | ❌ Invalid                    |
+| -------------------------------------------- | ----------------------------- |
+| `feat: Add network speed display to polybar` | `Added new feature`           |
+| `fix: Correct battery detection on desktops` | `fix - battery bug`           |
+| `docs: Update installation instructions`     | `updated docs`                |
+
+### 8. CI Checks
+
+Your PR will automatically run these checks:
+
+| Check              | What It Does                           |
+| ------------------ | -------------------------------------- |
+| **PR Title Check** | Validates conventional commit format   |
+| **ShellCheck**     | Lints shell scripts for errors         |
+| **Conflict Check** | Detects merge conflicts with `latest`  |
+
+All checks must pass before merging.
+
+## Development Guidelines
+
+### Code Style
+
+**Shell Scripts:**
+- Run `shellcheck` before committing
+- Quote variables: `"$variable"` not `$variable`
+- Use `[[ ]]` for conditionals (not `[ ]`)
+- Add comments for complex logic
+- Follow [Google Shell Style Guide](https://google.github.io/styleguide/shellguide.html)
+
+**Config Files:**
+- Keep configs well-commented
+- Use consistent indentation
+- Document hardware-specific settings
+
+### Testing
+
+For full testing, run the installer on a Fedora system:
+
+```bash
+./install.sh
+```
+
+### Documentation
+
+- Update documentation to reflect any changes
+- Use clear and concise language
+- Follow the existing documentation style
+
+## What to Contribute
+
+**Good First Issues:**
+- Fix typos in docs or comments
+- Improve error messages in scripts
+- Add missing keybindings to cheatsheet
+- Better hardware detection
+
+**Feature Ideas:**
+- New polybar modules
+- Additional rofi themes
+- More cheatsheets (vim, tmux, etc.)
+- Improved install/uninstall scripts
+
+## Getting Help
+
+If you need help with the contribution process or have questions, feel free to:
+
+- Comment on the relevant issue
+- Ask questions in pull requests
+- Open a discussion for general questions
+
+---
+
+Thank you for contributing to draphyOS! Your efforts help make this project better for everyone.