Create CONTRIBUTING.md to document how to contribute to Burrow #6

New issue

Open

opened 2026-03-07 12:43:33 +00:00 by Vylpes · 0 comments

Vylpes commented

2026-03-07 12:43:33 +00:00

Owner

Estimate: 2

As a prospective contributor to Burrow, I need a clear CONTRIBUTING.md so I can quickly understand how to report issues, propose changes, and submit pull requests that match the repository’s expectations. This will reduce friction for contributors, improve PR quality, and make reviews faster.

Acceptance Criteria

A CONTRIBUTING.md file exists at the repository root.
The guide includes:
- How to open issues (templates or required info).
- How to propose changes (branching and PR workflow).
- Coding standards and formatting (.editorconfig, style rules, naming).
- How to run and test templates locally (commands to install/use dotnet new, run samples).
- How to add/modify templates and package/publish them (dotnet new template guidance).
- CI expectations (tests to pass, linting).
- Versioning and release notes process.
- Labeling, triage, and expected response times.
- Links to Code of Conduct and LICENSE.
A short PR checklist is included in the guide.
The guide is reviewed and approved by at least one maintainer.

Subtasks

Draft CONTRIBUTING.md (this PR provides a starter draft)
Add or link to Code of Conduct and LICENSE if not already present
Add sample issue and PR templates (optional, but recommended)
Add CI checks to pipeline if missing or reference existing checks in the guide
Review and finalize content with maintainers

Estimate: 2 --- As a prospective contributor to Burrow, I need a clear CONTRIBUTING.md so I can quickly understand how to report issues, propose changes, and submit pull requests that match the repository’s expectations. This will reduce friction for contributors, improve PR quality, and make reviews faster. ## Acceptance Criteria - A CONTRIBUTING.md file exists at the repository root. - The guide includes: - How to open issues (templates or required info). - How to propose changes (branching and PR workflow). - Coding standards and formatting (.editorconfig, style rules, naming). - How to run and test templates locally (commands to install/use dotnet new, run samples). - How to add/modify templates and package/publish them (dotnet new template guidance). - CI expectations (tests to pass, linting). - Versioning and release notes process. - Labeling, triage, and expected response times. - Links to Code of Conduct and LICENSE. - A short PR checklist is included in the guide. - The guide is reviewed and approved by at least one maintainer. ## Subtasks - [ ] Draft CONTRIBUTING.md (this PR provides a starter draft) - [ ] Add or link to Code of Conduct and LICENSE if not already present - [ ] Add sample issue and PR templates (optional, but recommended) - [ ] Add CI checks to pipeline if missing or reference existing checks in the guide - [ ] Review and finalize content with maintainers

CONTRIBUTING.md

4.6 KiB

Vylpes added this to the 0.1.0 milestone

2026-03-07 12:43:33 +00:00

Vylpes added the

labels

2026-03-07 12:43:33 +00:00

Vylpes changed title from ~~Contributing guide~~ to Create CONTRIBUTING.md to document how to contribute to Burrow .NET website template

2026-03-28 12:05:02 +00:00

Vylpes changed title from ~~Create CONTRIBUTING.md to document how to contribute to Burrow .NET website template~~ to Create CONTRIBUTING.md to document how to contribute to Burrow

2026-03-28 12:05:08 +00:00

Vylpes added

and removed

labels

2026-03-28 12:07:17 +00:00