From 66d765a865039302686f7cfd866b9460af24a128 Mon Sep 17 00:00:00 2001 From: "Max T. Kristiansen" Date: Sat, 27 Jul 2024 19:25:01 +0200 Subject: [PATCH] docs: Add OSS boilerplate --- CODE_OF_CONDUCT.md | 133 +++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 130 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 69 +++++++++++++++++++++++ 3 files changed, 332 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 README.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..67fa72f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# 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, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## 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 +[me@maxtrier.dk](mailto:me@maxtrier.dk). +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 interactions 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.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c65ecf2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,130 @@ +# Contributing + +🎉 Hey, thanks for taking the time to contribute! 🎉 + +Check out some of the open issues and see if anything fits your skills. If you have an idea for a new feature, you can also open a new issue. + +If that doesn't fit, you can also write documentation or fix typos, as there might be a handful. + +## Code of Conduct + +This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to project moderators. + +You can read our [Code of Conduct here](./CODE_OF_CONDUCT.md). + +## Pull Requests + +**Doing your first pull request?** Great, awesome to have you on-board! If you're unsure how to start, you can learn how from this *free* series: [How to Contribute to an Open Source Project on GitHub.](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) + +- To avoid wasted development time, **please discuss** the change you wanna make. This can be done with on [GitLab Issues](https://git.maxtrier.dk/natamo/paracord/-/issues) or [GitHub Issues](https://github.com/maxnatamo/paracord/issues). If possible, discuss it publicly, so other people can chime in. +- The `develop` branch is used for the current development build. For that reason, **please, do not submit your PRs against the `main` branch.** +- Ensure that your code **respects the repository's formatting standard** (defined [here](/.editorconfig)). To do this, you can run: +```bash +dotnet format --verify-no-changes +``` +Or, with [Nuke](https://nuke.build): +```bash +nuke Format +``` +- Make sure your code **passes the tests**. Do do this, you can run: +```bash +dotnet test +``` +Or, with [Nuke](https://nuke.build): +```bash +nuke Test +``` + +It is also recommended to add new tests, if you're implementing a new feature. + +## Development Setup + +There are a few ways of setting up the project for development. + +### Required tools: +- Code editor + - We recommend [VS Code](https://code.visualstudio.com/). Upon opening the project, a few extensions will be automatically recommended for install. +- [.NET SDK 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) +- [Git](https://git-scm.com/downloads) + +### Getting started + +1. Fork the repository to your own account and clone it: + ```sh + git clone https://github.com/YOUR_USERNAME/fetcharr.git + cd fetcharr/ + ``` + +2. Add the `upstream` remote: + ```sh + git remote add upstream https://github.com/fetcharr/fetcharr.git + ``` + +3. Create a new branch: + ```sh + git checkout -b BRANCH_NAME develop + ``` + + - For the sake of the maintainers, we recommend you give your branch a meaningful name which sumarizes what the contribution does. + - Good examples: + - `feat-healthz-endpoint` + - `fix-plex-cache-invalidation` + - `docs-readme-typo` + - Bad examples: + - `bug-fix` + - `feature` + - `develop` + +4. Setup your development environment: +```sh +dotnet build src/Fetcharr.sln +dotnet run --project src/API/src/Fetcharr.API.csproj +``` + +5. Add your contribution and test your changes. +- Be sure to follow both the [code guidelines](#code-guidelines) and [commit guidelines](#commit-guidelines). +- If you need to update your fork, rebase from `develop`: + ```sh + git fetch upstream + git rebase upstream/develop + git push origin BRANCH_NAME -f + ``` + +## Code Guidelines + +- Your code **must** be formatted correctly; otherwise the tests will fail. + - Before committing, it is a good idea to run `dotnet format` to make sure everything is correct. + - If you use VS Code, it should also warn you about incorrectly formatted code (although, not always). +- Always rebase your commit to the latest `develop` branch. **Do not merge** `develop` into your branch. +- All commits **must** follow the guidelines in [Commit Guidelines](#commit-guidelines). + +## Commit Guidelines + +This repository takes use of a slightly modified version of the [Angular commit guidelines](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format). + +### Types + +| Types | Description | +| -------- | -------------------------------------------------------------------------------------------------------- | +| build | New build version. | +| chore | Changes to the build process or auxiliary tools such as changelog generation. No production code change. | +| ci | Changes related to continuous integration only (GitHub Actions, CircleCI, etc.). | +| docs | Documentation only changes. | +| feat | A new feature. | +| fix | A bug fix, whether it fixes an existing issue or not. | +| perf | A code change that improves performance. | +| refactor | A code change that neither fixes a bug nor adds a feature. | +| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.). | +| test | Adding missing or correcting existing tests. | + +### Scopes + +Instead of using a pre-defined list of scopes, the scope should define the affected component in the project tree. + +For example, if you add a new feature to the Sonarr provider, the scope might be `sonarr`. Other examples include `plex`, `cache`, `config`, etc. + +Please, try to be precise enough to describe the field of the change, but not so precise that the scope loses it's meaning. + +## Versioning + +This repository takes use of [Semantic Versioning](https://semver.org) for new releases. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..5875b4f --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +

+ 🫳 Fetcharr +

+ +> An automatic, open-source syncing application, connecting Plex with Radarr and Sonarr. + +
+ + + + + + +
+ + + + + + + + + +
+ +# 🫳 Fetcharr + +**Fetcharr** syncs your Plex watchlist to your Sonarr/Radarr instances. + +## Current features +- Easy integration with Radarr and Sonarr. +- Customizable filter rules. Allows for instances specific to anime, content for kids, etc. +- It works cross platform (works on AMD64, ARM and ARM64) via Docker. +- Frequently syncs your watchlist (currently every 30 seconds) instead of 20 minutes. + +As it stands currently, Fetcharr is still very new, so many features have yet to be implemented. If you have a good idea, check out our [issue tracker](https://github.com/Fetcharr/fetcharr/issues) and request it. + +## 🐋 Getting Started + +To use Fetcharr, make sure you have Docker installed and run the following command: + +```sh +docker run -d \ + --name fetcharr \ + -e TZ=Europe/Copenhagen \ + -v /path/to/appdata/config:/config + --restart unless-stopped + ghcr.io/fetcharr/fetcharr:latest +``` + +If you prefer a more *declarative* way of starting Fetcharr, use this `compose.yaml` file: + +```yaml +services: + fetcharr: + image: ghcr.io/fetcharr/fetcharr:latest + container_name: fetcharr + environment: + TZ: Europe/Copenhagen + volumes: + - /path/to/appdata/config:/config + restart: unless-stopped +``` + +## 📝 Contributing + +If you want to contribute, great! We'd love your help! + +For more in-depth information on contributing to the project and how to get started, see [CONTRIBUTING](CONTRIBUTING.md). \ No newline at end of file