From 6b1f480a26d1ff20f31c87f53fa4ed7977b5e66a Mon Sep 17 00:00:00 2001 From: Tatsuro Shibamura Date: Sun, 8 Mar 2026 02:14:03 +0900 Subject: [PATCH] Add CONTRIBUTING.md and SECURITY.md; update LICENSE and README.md for clarity --- CONTRIBUTING.md | 47 +++++++++++++++++++ LICENSE | 2 +- README.md | 8 ++++ SECURITY.md | 25 ++++++++++ .../Sharprompt.SourceGenerator.csproj | 3 ++ Sharprompt/Sharprompt.csproj | 7 +++ 6 files changed, 91 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..367e3803 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing + +Thanks for contributing to Sharprompt. + +## Development Environment + +- .NET 8 SDK +- A terminal that supports interactive console applications + +## Setup + +```sh +dotnet restore +dotnet build -c Release +dotnet test -c Release +``` + +The example project can be run with: + +```sh +dotnet run --project Sharprompt.Example +``` + +## Before Opening a Pull Request + +Please make sure the following commands succeed locally: + +```sh +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. diff --git a/LICENSE b/LICENSE index 31e0d547..4a09ba28 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019 shibayan +Copyright (c) 2019-2026 Tatsuro Shibamura Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 5af1c8dc..daa92e2e 100644 --- a/README.md +++ b/README.md @@ -250,6 +250,14 @@ var city = Prompt.Select(o => o.WithMessage("Select your city") - macOS - Terminal.app +## Contributing + +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for local setup, validation commands, and pull request expectations. + +## Security + +Please see [SECURITY.md](SECURITY.md) for how to report vulnerabilities privately. + ## License This project is licensed under the [MIT License](https://github.com/shibayan/Sharprompt/blob/master/LICENSE) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..c628750d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,25 @@ +# Security Policy + +## Supported Versions + +Security fixes are provided for the latest code on the `master` branch and the latest package published to NuGet. + +Older versions may receive fixes at the maintainer's discretion, but support is not guaranteed. + +## Reporting a Vulnerability + +Please do not report security vulnerabilities through public GitHub issues. + +Send a report to `me@shibayan.jp` with the following information when possible: + +- A short description of the issue +- Affected versions +- Reproduction steps or a proof of concept +- Impact assessment +- Any suggested remediation + +You can write in either Japanese or English. + +Reports will be reviewed as quickly as possible. Initial triage is typically performed within 5 business days. + +After the report is validated, the maintainer will coordinate a fix and decide on disclosure timing. Public disclosure before a fix is available may put users at risk, so please allow time for remediation. diff --git a/Sharprompt.SourceGenerator/Sharprompt.SourceGenerator.csproj b/Sharprompt.SourceGenerator/Sharprompt.SourceGenerator.csproj index bbdb1e9a..8a102ff3 100644 --- a/Sharprompt.SourceGenerator/Sharprompt.SourceGenerator.csproj +++ b/Sharprompt.SourceGenerator/Sharprompt.SourceGenerator.csproj @@ -7,10 +7,13 @@ true true false + true + true + diff --git a/Sharprompt/Sharprompt.csproj b/Sharprompt/Sharprompt.csproj index f01ea8f4..8218d2cb 100644 --- a/Sharprompt/Sharprompt.csproj +++ b/Sharprompt/Sharprompt.csproj @@ -11,11 +11,14 @@ Sharprompt icon.png README.md + https://github.com/shibayan/Sharprompt https://github.com/shibayan/Sharprompt/releases/tag/v$(Version) MIT cli;command-line;console;interactive;prompt;terminal + true https://github.com/shibayan/Sharprompt git + true @@ -23,6 +26,10 @@ + + + + True