testcontainers / testcontainers/testcontainers-dotnet

[Enhancement]: csharpier for formatting

Open
#1,501 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C#
Stars
4.4k
Forks
357
Avg merge
14h 42m
Merged PRs (30d)
16

Description

Problem

When I was working on the code, my IDE formatted the code in a way that didn't match the repository's style.

Solution

Format the code with csharpier and automatically check the formatting via a GitHub Action.

Benefit
  • It would no longer be a manual task to check if the formatting is correct.
  • It would level opinions about the formatting (It's the way the formatter does it and that's the way it is.)
Alternatives

Another formatter, e.g. dotnet format. But that one isn't as rigorous, and it's also slow.

Would you like to help contributing this enhancement?

Yes

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the repository's existing formatting setup and GitHub Actions workflows, then compare the proposed CSharpier approach with the mentioned dotnet format alternative. Done means the repository is formatted consistently with CSharpier and an automated GitHub Action checks formatting changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, github-actions
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.