Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (32 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.05 KB

Contributing

Thanks for contributing to Sharprompt.

Development Environment

  • .NET 8 SDK
  • A terminal that supports interactive console applications

Setup

dotnet restore
dotnet build -c Release
dotnet test -c Release

The example project can be run with:

dotnet run --project samples/Sharprompt.Example

Before Opening a Pull Request

Please make sure the following commands succeed locally:

dotnet build -c Release
dotnet test -c Release --no-build
dotnet format --verify-no-changes --verbosity detailed --no-restore

Contribution Guidelines

  • Keep changes focused on a single problem or feature.
  • Add or update tests when behavior changes.
  • Update the README or examples when public APIs or user-facing behavior change.
  • Prefer small, reviewable pull requests.

Pull Requests

  • Describe the motivation for the change.
  • Summarize the behavior change clearly.
  • Link related issues when applicable.

By submitting a contribution, you agree that your work will be released under the MIT License used by this repository.