Skip to content

Commit 66d765a

Browse files
maxnatamomaxnatamo
committed
docs: Add OSS boilerplate
1 parent 3d3068d commit 66d765a

3 files changed

Lines changed: 332 additions & 0 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[me@maxtrier.dk](mailto:me@maxtrier.dk).
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Contributing
2+
3+
🎉 Hey, thanks for taking the time to contribute! 🎉
4+
5+
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.
6+
7+
If that doesn't fit, you can also write documentation or fix typos, as there might be a handful.
8+
9+
## Code of Conduct
10+
11+
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.
12+
13+
You can read our [Code of Conduct here](./CODE_OF_CONDUCT.md).
14+
15+
## Pull Requests
16+
17+
**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)
18+
19+
- 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.
20+
- The `develop` branch is used for the current development build. For that reason, **please, do not submit your PRs against the `main` branch.**
21+
- Ensure that your code **respects the repository's formatting standard** (defined [here](/.editorconfig)). To do this, you can run:
22+
```bash
23+
dotnet format --verify-no-changes
24+
```
25+
Or, with [Nuke](https://nuke.build):
26+
```bash
27+
nuke Format
28+
```
29+
- Make sure your code **passes the tests**. Do do this, you can run:
30+
```bash
31+
dotnet test
32+
```
33+
Or, with [Nuke](https://nuke.build):
34+
```bash
35+
nuke Test
36+
```
37+
38+
It is also recommended to add new tests, if you're implementing a new feature.
39+
40+
## Development Setup
41+
42+
There are a few ways of setting up the project for development.
43+
44+
### Required tools:
45+
- Code editor
46+
- We recommend [VS Code](https://code.visualstudio.com/). Upon opening the project, a few extensions will be automatically recommended for install.
47+
- [.NET SDK 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
48+
- [Git](https://git-scm.com/downloads)
49+
50+
### Getting started
51+
52+
1. Fork the repository to your own account and clone it:
53+
```sh
54+
git clone https://github.com/YOUR_USERNAME/fetcharr.git
55+
cd fetcharr/
56+
```
57+
58+
2. Add the `upstream` remote:
59+
```sh
60+
git remote add upstream https://github.com/fetcharr/fetcharr.git
61+
```
62+
63+
3. Create a new branch:
64+
```sh
65+
git checkout -b BRANCH_NAME develop
66+
```
67+
68+
- For the sake of the maintainers, we recommend you give your branch a meaningful name which sumarizes what the contribution does.
69+
- Good examples:
70+
- `feat-healthz-endpoint`
71+
- `fix-plex-cache-invalidation`
72+
- `docs-readme-typo`
73+
- Bad examples:
74+
- `bug-fix`
75+
- `feature`
76+
- `develop`
77+
78+
4. Setup your development environment:
79+
```sh
80+
dotnet build src/Fetcharr.sln
81+
dotnet run --project src/API/src/Fetcharr.API.csproj
82+
```
83+
84+
5. Add your contribution and test your changes.
85+
- Be sure to follow both the [code guidelines](#code-guidelines) and [commit guidelines](#commit-guidelines).
86+
- If you need to update your fork, rebase from `develop`:
87+
```sh
88+
git fetch upstream
89+
git rebase upstream/develop
90+
git push origin BRANCH_NAME -f
91+
```
92+
93+
## Code Guidelines
94+
95+
- Your code **must** be formatted correctly; otherwise the tests will fail.
96+
- Before committing, it is a good idea to run `dotnet format` to make sure everything is correct.
97+
- If you use VS Code, it should also warn you about incorrectly formatted code (although, not always).
98+
- Always rebase your commit to the latest `develop` branch. **Do not merge** `develop` into your branch.
99+
- All commits **must** follow the guidelines in [Commit Guidelines](#commit-guidelines).
100+
101+
## Commit Guidelines
102+
103+
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).
104+
105+
### Types
106+
107+
| Types | Description |
108+
| -------- | -------------------------------------------------------------------------------------------------------- |
109+
| build | New build version. |
110+
| chore | Changes to the build process or auxiliary tools such as changelog generation. No production code change. |
111+
| ci | Changes related to continuous integration only (GitHub Actions, CircleCI, etc.). |
112+
| docs | Documentation only changes. |
113+
| feat | A new feature. |
114+
| fix | A bug fix, whether it fixes an existing issue or not. |
115+
| perf | A code change that improves performance. |
116+
| refactor | A code change that neither fixes a bug nor adds a feature. |
117+
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.). |
118+
| test | Adding missing or correcting existing tests. |
119+
120+
### Scopes
121+
122+
Instead of using a pre-defined list of scopes, the scope should define the affected component in the project tree.
123+
124+
For example, if you add a new feature to the Sonarr provider, the scope might be `sonarr`. Other examples include `plex`, `cache`, `config`, etc.
125+
126+
Please, try to be precise enough to describe the field of the change, but not so precise that the scope loses it's meaning.
127+
128+
## Versioning
129+
130+
This repository takes use of [Semantic Versioning](https://semver.org) for new releases.

‎README.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<h1 align="center">
2+
🫳 Fetcharr
3+
</h1>
4+
5+
> An automatic, open-source syncing application, connecting Plex with Radarr and Sonarr.
6+
7+
<div align="center">
8+
<a href="https://github.com/maxnatamo/fetcharr/blob/main/LICENSE">
9+
<img src="https://img.shields.io/github/license/fetcharr/fetcharr?style=for-the-badge" />
10+
</a>
11+
<a href="https://github.com/maxnatamo/fetcharr/blob/main/CONTRIBUTING.md">
12+
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge" />
13+
</a>
14+
<br />
15+
<a href="https://github.com/Fetcharr/fetcharr/releases">
16+
<img src="https://img.shields.io/github/v/release/fetcharr/fetcharr?style=for-the-badge&label=PROD" />
17+
</a>
18+
<a href="https://github.com/Fetcharr/fetcharr/releases?q=prerelease%3Afalse">
19+
<img src="https://img.shields.io/github/v/release/fetcharr/fetcharr?include_prereleases&style=for-the-badge&label=DEV" />
20+
</a>
21+
<a href="https://github.com/fetcharr/fetcharr/actions">
22+
<img src="https://img.shields.io/github/actions/workflow/status/fetcharr/fetcharr/release.yml?branch=main&label=Build&style=for-the-badge" />
23+
</a>
24+
</div>
25+
26+
# 🫳 Fetcharr
27+
28+
**Fetcharr** syncs your Plex watchlist to your Sonarr/Radarr instances.
29+
30+
## Current features
31+
- Easy integration with Radarr and Sonarr.
32+
- Customizable filter rules. Allows for instances specific to anime, content for kids, etc.
33+
- It works cross platform (works on AMD64, ARM and ARM64) via Docker.
34+
- Frequently syncs your watchlist (currently every 30 seconds) instead of 20 minutes.
35+
36+
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.
37+
38+
## 🐋 Getting Started
39+
40+
To use Fetcharr, make sure you have Docker installed and run the following command:
41+
42+
```sh
43+
docker run -d \
44+
--name fetcharr \
45+
-e TZ=Europe/Copenhagen \
46+
-v /path/to/appdata/config:/config
47+
--restart unless-stopped
48+
ghcr.io/fetcharr/fetcharr:latest
49+
```
50+
51+
If you prefer a more *declarative* way of starting Fetcharr, use this `compose.yaml` file:
52+
53+
```yaml
54+
services:
55+
fetcharr:
56+
image: ghcr.io/fetcharr/fetcharr:latest
57+
container_name: fetcharr
58+
environment:
59+
TZ: Europe/Copenhagen
60+
volumes:
61+
- /path/to/appdata/config:/config
62+
restart: unless-stopped
63+
```
64+
65+
## 📝 Contributing
66+
67+
If you want to contribute, great! We'd love your help!
68+
69+
For more in-depth information on contributing to the project and how to get started, see [CONTRIBUTING](CONTRIBUTING.md).

0 commit comments

Comments
 (0)