6.3 KiB

Raw Blame History

Contributing

First, thank you for your interest in contributing to my project. Below is a list of requirements that everyone should follow.

To avoid wasting your time and effort, please ensure all ideas get discussed first. Either visit the Ideas discussion board and open a thread there. I ask that you do this to avoid the potential of rejecting work already done in a pull request.
For Markdown changes, any and all changes must pass configured markdownlint rules (see the .markdownlint.json files in this repository for project-specific adjustments to those rules).
For C# changes, code must conform to the project's style. My day to day coding is done in Jetbrains Rider. If using that IDE, doing a simple Code Cleanup on modified source files should be enough. Make sure to select the "Recyclarr Cleanup" profile when you do the code cleanup. If you're using Visual Studio or some other editor, you are on your own. Formatting rules are stored in src/.editorconfig and src/Recyclarr.sln.DotSettings.

Tooling Requirements

The following tools are required:

.NET SDK 7.0 and tooling (e.g. dotnet)
Powershell v5.1 or greater
Docker CLI (Docker Desktop on Windows)

The following tools are highly recommended but not strictly required:

Jetbrains Rider (IDE for editing C# code)
Visual Studio Code (install workspace-recommended extensions as well)

Other required tooling can be installed via the Install-Tooling.ps1 powershell script. It's also a good idea to occasionally run this for upgrade purposes, too.

Docker Development

The project's Dockerfile build requires the Recyclarr build output to be placed in a specific location in order to succeed. The location is below, relative to the repository root:

docker/artifacts/recyclarr-${{runtime}}

Where ${{runtime}} is one of the runtimes compatible with dotnet publish, such as linux-musl-x64.

There is a convenience script named docker/Build-Artifacts.ps1 that will perform a build and place the output in the appropriate location for you. This simplifies the process of testing docker locally to these steps:

Run the convenience script to build and publish Recyclarr to the Docker artifacts directory:
```
pwsh ci/Build-Artifacts.ps1
```
Note: The runtime defaults to linux-musl-x64 but you can pass in an override as the first placeholder argument to the above command.

Execute a Docker build locally via compose:

docker compose build --no-cache --progress plain

Run the container to test it:

docker compose run --rm recyclarr sonarr

Build Arguments

TARGETPLATFORM (Default: empty)
Required. Specifies the runtime architecture of the image and is used to pull the correct prebuilt binary from the specified Github Release. See the table in the Platform Support section for a list of valid values.

Platform Support

Docker Platform	Recyclarr Runtime
`linux/arm/v7`	`linux-musl-arm`
`linux/arm64`	`linux-musl-arm64`
`linux/amd64`	`linux-musl-x64`

Conventional Commits

This project uses and enforces a variation of Conventional Commits. The below official commit types are used:

Official:

build: Update project files, settings, etc.
chore: Anything not code related or that falls into other categories.
ci: Changes to CI/CD scripts or configuration.
docs: Updates to non-code documentation (markdown, readme, etc).
feat: A new feature was implemented.
fix: A defect or security issue was fixed.
perf: Change in code related to improving performance.
refactor: A code change that does not impact the observable functionality or shape of the apps.
revert: Prefix to be used for commits made by the git revert command.
style: A whitespace or code cleanup change in code.
test: Updates to unit test code only.

Specialized:

change: Change to existing functionality.
deprecate: Deprecation of existing functionality.
remove: Removal of existing feature.

Release Process

Release numbering follows Semantic Versioning. The GitVersion package is used in .NET projects to automatically version the executable according to Conventional Commits rules in conjunction with semantic versioning.

The goal is to allow commit messages to drive the way the semantic version number is advanced during development. When a feature is implemented, the corresponding commit results in the minor version number component being advanced by 1. Similarly, the patch portion is advanced by 1 when a bugfix is committed.

To make a release, follow these steps:

Run Prepare-Release.ps1. This will do the following:
1. Update the changelog for the release according to Keep a Changelog rules.
2. Commit the changelog updates.
3. Create a tag for the release (using GitVersion).
Use Git to push the new tag and commits on master upstream where the Github Workflows will take over.

The Github Workflows manage the release process after the push by doing the following:

Compile the .NET projects.
Create a Github Release with the .NET artifacts attached.
Build and publish a new Docker image to the Github Container Registry and [Docker Hub][dockerhub].
Send a release notification to the #related-announcements channel in the official TRaSH Guides Discord.

Update `.gitignore`

Execute the Update-Gitignore.ps1 script using Powershell. The working directory must be the root of the repo. This will pull the latest relevant .gitignore patterns from gitignore.io and commit them automatically to your current branch.

6.3 KiB Raw Blame History