From aef75820837a8395b9402557af02ef1b27bc447b Mon Sep 17 00:00:00 2001 From: naturallaw77 Date: Mon, 27 Jul 2026 17:56:38 -0500 Subject: [PATCH] Added contributing and updated readme --- CONTRIBUTING.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 6 ++++ 2 files changed, 85 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8ad1bc2 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. + diff --git a/README.md b/README.md index 6564db1..c44b7bd 100644 --- a/README.md +++ b/README.md @@ -1034,8 +1034,14 @@ Read the complete license terms in [`LICENSE`](LICENSE). --- +## Contributing + +We welcome contributions! Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting a pull request. +
+--- + ## Privacy. Sovereignty. Bitcoin. ### Your Bitcoin life. Your keys. Your node. Your machine.