Added contributing and updated readme

2026-07-27 17:56:38 -05:00
parent c51a762b42
commit aef7582083
2 changed files with 85 additions and 0 deletions
@@ -0,0 +1,79 @@
+# Contributing to Sovran Systems OS
+
+First off, thank you for considering contributing to Sovran_SystemsOS! 🎉
+
+## This Github Repo
+
+This repo is for the development of Sovran_SystemsOS and to connect into the Github ecosystem. The main repo for Sovran_SystemsOS is on https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable. All activity in this Github repo is tested and eventually mirrored to the main repo on Gitea, as Sovran_SystemsOS is ethos is Self-Sovereignty.
+
+## How Can I Contribute?
+
+### 🐛 Reporting Bugs
+- Open an [Issue](https://github.com/naturallaw777/Sovran_SystemsOS/issues)
+- Use a clear and descriptive title
+- Describe the steps to reproduce the bug
+- Include your OS version, hardware specs, and any relevant logs
+
+### 💡 Suggesting Features
+- Open an [Issue](https://github.com/naturallaw777/Sovran_SystemsOS/issues) with the tag `enhancement`
+- Explain the feature and why it would be useful
+- Be as detailed as possible
+
+### 🔧 Submitting Code Changes
+
+#### 1. Fork the Repository
+Click the "Fork" button at the top right of this repository.
+
+#### 2. Clone Your Fork
+```bash
+git clone https://github.com/YOUR_USERNAME/Sovran_SystemsOS.git
+cd Sovran_SystemsOS
+```
+
+#### 3. Create a Feature Branch
+```bash
+git checkout -b feature/your-feature-name
+```
+
+#### 4. Make Your Changes
+- Write clean, well-commented code
+- Follow the existing code style and structure
+- Test your changes thoroughly
+
+#### 5. Commit Your Changes
+```bash
+git add .
+git commit -m "Brief description of your changes"
+```
+
+#### 6. Push to Your Fork
+```bash
+git push origin feature/your-feature-name
+```
+
+#### 7. Open a Pull Request
+- Go to the original repository on GitHub
+- Click "New Pull Request"
+- Select your fork and branch
+- Provide a clear title and description of your changes
+- Reference any related Issues (e.g., "Closes #12")
+
+## Pull Request Guidelines
+
+- **One PR per feature/fix.** Do not bundle unrelated changes.
+- **Keep PRs small and focused.** Smaller PRs are easier to review and merge.
+- **Write meaningful commit messages.**
+- **Do not push directly to `main`.** Always use a feature branch and open a PR.
+- **Be patient.** PRs will be reviewed as soon as possible.
+
+## Code Style
+
+- Follow the existing patterns in the codebase
+- Comment your code where necessary
+- Keep functions small and focused
+
+## Code of Conduct
+
+By participating in this project, you agree to be respectful and constructive.
+We are building something meaningful — let's do it together with integrity.
+