Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ for anything larger than an obvious fix. Say what you want to do and why. The
scope should be small enough to review in one sitting. Several small issues are
better than one large one.

Choose the form that fits:

| Form | For |
| --- | --- |
| Feature | Something berth can't do at all yet |
| Improvement | Something berth does already, but could do more easily, faster or more clearly |
| Integration | An agent, tool, provider or service, as a new plugin or in one that exists |

You don't have to wait for an answer before you start. Once the issue is
there, you can begin on the pull request straight away if you like. The order
is what matters, since the issue is where we find out whether the change
Expand All @@ -55,6 +63,22 @@ A few rules follow from that:
Typo fixes, broken links and small documentation corrections can go straight
to a pull request.

## How issues are handled

An issue's type, such as Bug, Feature or Improvement, says what kind it is.
Labels say the rest:

| Labels | Say |
| --- | --- |
| `area: …` | The task it's about, such as `area: deploy` or `area: access` |
| `needs triage`, `needs info`, `accepted`, `blocked` | Where the issue stands |
| `duplicate`, `out of scope`, `plugin candidate` | Why it was closed |

A new issue starts with `needs triage`. When it belongs in berth, it gets
`accepted`, and a pull request is welcome from then on. An idea that would
work better as a plugin is closed with `plugin candidate`, and one that
doesn't fit what berth is with `out of scope`.

## Using language models

Using a model to help is fine, and welcome. Most of berth was written with
Expand Down
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Bug
description: Something berth does wrong, or something that used to work and doesn't any more
type: Bug
labels: [needs triage]
body:
- type: textarea
id: what
attributes:
label: What happened
description: What you ran, what you expected and what you got. Your own words are best, even if short.
validations:
required: true
- type: textarea
id: output
attributes:
label: Output
description: The relevant output, and `berth run HOST status` if a host is involved. Take addresses, tokens and passwords out first.
render: text
- type: input
id: version
attributes:
label: berth --version
validations:
required: true
- type: dropdown
id: area
attributes:
label: What you were doing
options:
- Not sure
- Getting a new host running
- Choosing what a host gets, or applying it
- Looking after a running host
- Reaching a host (terminal, SSH, tunnels, desktop)
- Sign-ins, secrets, keys or registries
- Making hosts or resources on a node
- Using an agent or tool on a host
- Running a berth server for others
- Writing a plugin or using the API
- type: dropdown
id: surface
attributes:
label: Where you saw it
options:
- The screens
- The command line
- Both
- On the host itself
- type: dropdown
id: client
attributes:
label: Where berth runs
options:
- Linux
- macOS
- Windows
- type: dropdown
id: where
attributes:
label: How the host was installed
options:
- Not about a host
- USB installer
- Cloud seed
- SSH to an existing server
- Container
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Feature
description: Something berth can't do at all yet. This comes before the pull request.
type: Feature
labels: [needs triage]
body:
- type: markdown
attributes:
value: |
Read [CONTRIBUTING.md](https://github.com/helightdev/berth/blob/main/.github/CONTRIBUTING.md) first, in particular what berth is and isn't. Keep one issue to one change. If berth does this already but could do it better, use **Improvement**. For an agent, tool or service, use **Integration**.
- type: textarea
id: problem
attributes:
label: What you ran into
description: The situation that made you want this, in your own words.
validations:
required: true
- type: textarea
id: change
attributes:
label: What you propose
description: What berth would do that it can't do now.
validations:
required: true
- type: textarea
id: scope
attributes:
label: Scope
description: What is in and what is left out. Smaller is better.
- type: dropdown
id: plugin
attributes:
label: Could it be a plugin
description: Whatever works as a plugin should be one, often in a repository of its own.
options:
- Not sure
- "Yes"
- No, it needs a change to berth itself
- type: dropdown
id: area
attributes:
label: What you were doing
options:
- Not sure
- Getting a new host running
- Choosing what a host gets, or applying it
- Looking after a running host
- Reaching a host (terminal, SSH, tunnels, desktop)
- Sign-ins, secrets, keys or registries
- Making hosts or resources on a node
- Using an agent or tool on a host
- Running a berth server for others
- Writing a plugin or using the API
- type: checkboxes
id: work
attributes:
label: Who does it
options:
- label: I'd like to write this myself
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/3-improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Improvement
description: Something berth does already, but that could be easier, faster or clearer
type: Improvement
labels: [needs triage]
body:
- type: textarea
id: now
attributes:
label: What berth does now
description: What you did and what got in the way, in your own words.
validations:
required: true
- type: textarea
id: better
attributes:
label: What would be better
description: How it would work instead.
validations:
required: true
- type: dropdown
id: area
attributes:
label: What you were doing
options:
- Not sure
- Getting a new host running
- Choosing what a host gets, or applying it
- Looking after a running host
- Reaching a host (terminal, SSH, tunnels, desktop)
- Sign-ins, secrets, keys or registries
- Making hosts or resources on a node
- Using an agent or tool on a host
- Running a berth server for others
- Writing a plugin or using the API
- type: checkboxes
id: work
attributes:
label: Who does it
options:
- label: I'd like to write this myself
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/4-integration.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Integration
description: Support for an agent, tool, provider or service, as a new plugin or in one that exists
type: Integration
labels: [needs triage]
body:
- type: markdown
attributes:
value: |
Most integrations are plugins, and a plugin can live in a repository of its own. [Writing plugins](https://berth.helight.dev/docs/extend/writing-plugins/) says how.
- type: input
id: tool
attributes:
label: Which agent, tool or service
description: Its name and a link.
validations:
required: true
- type: textarea
id: what
attributes:
label: What berth should do with it
description: What it should install, set up or sign in to, and what you do by hand today.
validations:
required: true
- type: dropdown
id: plugin
attributes:
label: Plugin
options:
- A new plugin
- More from a plugin that comes with berth
- Not sure
- type: checkboxes
id: work
attributes:
label: Who does it
options:
- label: I'd like to write this myself
- label: I'd keep it working after it's merged
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/5-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Documentation
description: The docs are wrong, missing something or hard to follow
type: Documentation
labels: [needs triage]
body:
- type: input
id: page
attributes:
label: Page
description: A link to the page, or where you looked.
- type: textarea
id: what
attributes:
label: What's wrong or missing
description: What you were trying to do and where the docs let you down.
validations:
required: true
- type: dropdown
id: area
attributes:
label: What you were doing
options:
- Not sure
- Getting a new host running
- Choosing what a host gets, or applying it
- Looking after a running host
- Reaching a host (terminal, SSH, tunnels, desktop)
- Sign-ins, secrets, keys or registries
- Making hosts or resources on a node
- Using an agent or tool on a host
- Running a berth server for others
- Writing a plugin or using the API
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/6-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Question
description: How do I…? Or you're not sure whether something is a bug
type: Question
labels: [needs triage]
body:
- type: textarea
id: goal
attributes:
label: What you're trying to do
validations:
required: true
- type: textarea
id: tried
attributes:
label: What you tried
description: Commands, docs pages, output. Take addresses, tokens and passwords out first.
- type: input
id: version
attributes:
label: berth --version
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug.yml

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/proposal.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- Features and changes in behaviour need an issue that was opened before this pull request. See CONTRIBUTING.md. -->
<!-- Features, improvements, integrations and other changes in behaviour need an issue that was opened before this pull request. See CONTRIBUTING.md. -->

Issue: #

Expand Down
Loading
Loading