Skip to content

Commit

Permalink
templates: rototill
Browse files Browse the repository at this point in the history
  • Loading branch information
gdt committed Feb 2, 2025
1 parent e027b9e commit ddf08c4
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 12 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/defect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Defect
about: Create an issue that argues that there is a bug in unison
title: ''
labels: ''
assignees: ''
---

# Instructions

The issue tracker is not a help system. Before using the issue
tracker, please read the following page thoroughly and follow the
guidelines it expresses:

https://github.com/bcpierce00/unison/wiki/Reporting-Bugs-and-Feature-Requests

Pleaes delete the following dashed line and the text above it, leaving the
statement that you have read the wiki page.
----------------------------------------
I have thoroughly read the [Reporting Bugs and Feature Requests](https://github.com/bcpierce00/unison/wiki/Reporting-Bugs-and-Feature-Requests) wiki page.

# Meta

Bug reports must be minimal, as described in the wiki page.

People filing bug reports will be expected to follow up and perhaps
test proposed fixes.

# Environment

- Unison version
- OS, version and CPU
- ocaml version
- TUI or GUI
- local, ssh, socket, or ?
- use of fsmonitor?

# Reproduction Recipe

Describe how to reproduce the bug

# Expected behavior vs actual behavior
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Feature
about: Create a well-thought out feature request
title: ''
labels: ''
assignees: ''
---

# Instructions

Before using the issue tracker, please read the following page
thoroughly and follow the guidelines it expresses:

https://github.com/bcpierce00/unison/wiki/Reporting-Bugs-and-Feature-Requests

If your feature request is not fully formed, please post on
unison-hackers@ instead.

Pleaes delete the following dashed line and the text above it, leaving the
statement that you have read the wiki page.
----------------------------------------
I have thoroughly read the [Reporting Bugs and Feature Requests](https://github.com/bcpierce00/unison/wiki/Reporting-Bugs-and-Feature-Requests) wiki page.

# Motivation

Explain what you want to do.

# Background

Explain why the documentation and current behavior do not permit
achieving your goals. For near misses, explain.

# Scope

Discuss whether the proposed behavior is aligned with unison's historical scope and why it is a reasonable change.

If there are portability concerns, discuss them.

# Will you write code?

Say whether you intend to implement the feature. (If so, it is
entirely reasonable to ask first if it would be accepted if written,
if you don't want to spend time on a feature that won't be merged).

# Operation of the new feature

Explain how the new feature will behave, enough that someone else (who
is familiar with unison) could implement it.

Discuss problems that will arise and how they should be handled.

# Complexity vs Benefit

Discuss the tradeoff of complexity in the code base and documentation
vs the benefit to users. Generally, proposed features should be of
fairly broad interest.

12 changes: 0 additions & 12 deletions .github/issue-template.md

This file was deleted.

0 comments on commit ddf08c4

Please sign in to comment.