diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..b685277 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,121 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that are welcoming, open, and respectful. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[tylerzanekelley@gmail.com]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interaction in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8872211..40e5175 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,32 +1,82 @@ -# Contributing Guidelines +# 💖 Contributing to ZaneyOS -👋 Hello there! We're thrilled that you're considering contributing to our project. Before you start, please take a moment to read our guidelines. +We're excited that you're interested in contributing to ZaneyOS! Your help is +essential for keeping it great. -## Table of Contents +This document is a guide to help you through the process of contributing to +ZaneyOS. We are a welcoming and friendly community, and we are happy to help you +get started. -- [How Can I Contribute?](#how-can-i-contribute) - - [Reporting Bugs](#reporting-bugs) - - [Suggesting Enhancements](#suggesting-enhancements) - - [Code Contribution](#code-contribution) +## 📜 Code of Conduct -## Code of Conduct +We have a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect all contributors +to adhere to. Please take a moment to read it before you start contributing. -None. Don't be a turd and we'll be just fine 'round here. 🤠 +## 🚀 How to Contribute -## How Can I Contribute? +There are many ways to contribute to ZaneyOS, from writing code to reporting +bugs and suggesting new features. -### Reporting Bugs +### 🐛 Reporting Bugs -Found a bug? Please ensure the bug was not already reported by searching our [issues](../../issues). If not, open a new issue and fill out the template provided. +If you find a bug, please open an issue on our [issue tracker](../../issues). -### Suggesting Enhancements +When you report a bug, please include the following: -Have an idea for an enhancement? We'd love to hear it! Open an issue and include [Feature Request]. +- A clear and descriptive title. +- A detailed description of the bug, including steps to reproduce it. +- Your environment details (OS, ZaneyOS version, etc.). +- Any relevant logs or screenshots. -### Code Contribution +### ✨ Suggesting Enhancements + +If you have an idea for a new feature or an enhancement to an existing one, +please open an issue on our [issue tracker](../../issues). + +When you suggest an enhancement, please include the following: + +- A clear and descriptive title. +- A detailed description of the enhancement, including the problem it solves and + why it would be a good addition to ZaneyOS. +- Any relevant mockups or screenshots. + +### 💻 Code Contributions + +If you want to contribute code to ZaneyOS, please follow these steps: + +1. **Fork the repository** and clone it to your local machine. +2. **Create a new branch** for your changes: `git checkout -b your-branch-name` +3. **Make your changes** and commit them with a clear and descriptive commit + message. +4. **Push your changes** to your fork: `git push origin your-branch-name` +5. **Open a pull request** to the `main` branch of the ZaneyOS repository. + +When you open a pull request, please include the following: + +- A clear and descriptive title. +- A detailed description of the changes, including the problem it solves and how + you solved it. +- Any relevant issue numbers. + +## 🎨 Style Guide + +We have a style guide that we expect all contributors to follow. Please take a +moment to read it before you start contributing. + +- **Git Commit Messages:** We use the + [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) + specification for our commit messages. +- **Code Style:** We use `shfmt` to format our shell scripts. Please make sure + your code is formatted before you open a pull request. + +## 💬 Community + +If you have any questions or want to get in touch with the community, you can +find us on: + +- **Discord:** [Join our Discord server](https://discord.gg/CHZzESXs) +- **Twitter:** [@ZaneyOS](https://twitter.com/ZaneyOS) + +We are happy to help you get started with contributing to ZaneyOS. We look +forward to your contributions! -1. Fork the repository. -2. Create a new branch for your feature/fix: `git checkout -b feature-branch` -3. Make your changes and commit: `git commit -m 'Add new feature'` -4. Push to your fork: `git push origin feature-branch` -5. Open a pull request with a clear title and description. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..6b847f3 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,25 @@ +# 📜 License + +### ZaneyOS is licensed under the MIT License. + +## MIT License + +**Copyright (c) 2025 Tyler Kelley** + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software" ), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.** diff --git a/README.md b/README.md index 311912e..ba79083 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ ZaneyOS is a simple way of reproducing my configuration on any NixOS system. Thi -> **This project has a [Wiki](https://zaney.org/zaneyos-2.0/). Find out how to use ZaneyOS here!** -> **I have put a lot of effort into the [documentation](https://zaney.org/zaneyos-2.0/) so it should be accurate. However, please if you notice that something is wrong with it create an issue or reach out to me on Discord.** +> **This project has a [Wiki](https://zaney.org/wiki/zaneyos-2.0/). Find out how to use ZaneyOS here!** +> **I have put a lot of effort into the [documentation](https://zaney.org/wiki/zaneyos-2.0/) so it should be accurate. However, please if you notice that something is wrong with it create an issue or reach out to me on Discord.** ### Announcing ZaneyOS 2.0! @@ -43,7 +43,7 @@ My hope is that with this update your ability to grasp the flake and expand it t
-Please do yourself a favor and [read the wiki](https://zaney.org/zaneyos-2.0/). +Please do yourself a favor and [read the wiki](https://zaney.org/wiki/zaneyos-2.0/).
@@ -65,7 +65,12 @@ Simply copy this and run it: ``` nix-shell -p git curl -sh <(curl -L https://gitlab.com/Zaney/zaneyos/-/raw/main/install-zaneyos.sh) +``` + +Then: + +``` +sh <(curl -L https://gitlab.com/Zaney/zaneyos/-/raw/stable-2.0/install-zaneyos.sh) ``` #### 🦽 Manual: @@ -79,7 +84,7 @@ nix-shell -p git vim Clone this repo & enter it: ``` -git clone https://gitlab.com/zaney/zaneyos.git +git clone -b stable-2.0 --single-branch https://gitlab.com/zaney/zaneyos.git cd zaneyos ``` diff --git a/install-zaneyos.sh b/install-zaneyos.sh index a0045e0..d09b4d9 100755 --- a/install-zaneyos.sh +++ b/install-zaneyos.sh @@ -56,7 +56,7 @@ fi echo "-----" echo "Cloning & Entering ZaneyOS Repository" -git clone https://gitlab.com/zaney/zaneyos.git +git clone -b stable-2.0 --single-branch https://gitlab.com/zaney/zaneyos.git cd zaneyos || exit mkdir hosts/"$hostName" cp hosts/default/*.nix hosts/"$hostName"