diff --git a/.github/ISSUE_TEMPLATE/but_report.yml b/.github/ISSUE_TEMPLATE/but_report.yml new file mode 100644 index 0000000..1dff239 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/but_report.yml @@ -0,0 +1,29 @@ +name: "🐞 Bug report" +description: Create a report to help us improve +title: "[Bug]: " +labels: ["bug"] +body: + - type: textarea + id: repro + attributes: + label: Steps to reproduce + placeholder: "1. Run `rpcp ...`\n2. ...\n" + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behaviour + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual behaviour + validations: + required: true + - type: input + id: version + attributes: + label: repocopy version + placeholder: "v0.1.0" diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD new file mode 100644 index 0000000..a0e00e3 --- /dev/null +++ b/CONTRIBUTING.MD @@ -0,0 +1,26 @@ +# Contributing to repocopy + +First off, thanks for taking the time to contribute! + +## How to report a bug + +1. **Search existing issues** – your bug may already be fixed or reported. +2. **Open a _Bug report_ issue** using the template. +3. Include: + * Steps to reproduce + * Expected vs. actual behaviour + * Your OS / shell / repocopy version + +## How to request a feature + +Open a _Feature request_ issue and describe: +* The problem you’re trying to solve +* A concise proposal (CLI flag, behaviour change, …) +* Any alternatives you considered + +## Pull-request guidelines + +* One logical change per PR +* Run `./ci-local-test.sh` (Bats & Pester) – all tests must pass +* Follow existing code style; bash-strict mode & PowerShell `Set-StrictMode` +* Add tests for new behaviour diff --git a/README.md b/README.md index 592b0ab..a492d0b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # repocopy (rpcp) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) +[![Release](https://img.shields.io/github/v/release/dickymoore/repocopy)](https://github.com/dickymoore/repocopy/releases) +[![CI](https://github.com/dickymoore/repocopy/actions/workflows/ci.yml/badge.svg)](https://github.com/dickymoore/repocopy/actions/workflows/ci.yml) ### What is it? A lightweight utility to copy the file contents of a local directory to the clipboard.