ardalis/Ardalis.Extensions

Add usage examples to README

Open

#62 opened on Oct 21, 2022

View on GitHub
 (4 comments) (0 reactions) (1 assignee)C# (37 forks)github user discovery
documentationenhancementgood first issuehacktoberfest

Repository metrics

Stars
 (161 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Show basic usage of each extension in the README.

Organize using same organization as folder structure of code.

Show how to perform the operation without the extension, and then what it looks like with the extension.

Contributor guide

Research direction
Read the existing code to understand each extension method, then write usage examples in the README following the folder structure. For each method, show the code without the extension and then with the extension.
Tech stack
csharp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70