-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
feat: CONTRIBUTING.md and Bug Report template (#117)
This change introduces an initial CONTRIBUTING.md doc and a template for bug reports. Signed-off-by: Khionu Sybiern <[email protected]>
Showing
2 changed files
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Bug Report | ||
description: File a bug report. | ||
title: "bug: " | ||
labels: ["bug"] | ||
assignees: | ||
- edera-dev/engineering | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: Also tell us, what did you expect to happen? | ||
placeholder: Tell us what you see! | ||
value: "A bug happened!" | ||
validations: | ||
required: true | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Version / Commit | ||
description: What version of our software are you running? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: shell | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Contributing to Krata | ||
|
||
Welcome! We're very glad you're reading this; Edera is excited for all kinds of contributions! Please read the following to ensure you're aware of our flow and policies. | ||
|
||
## Before contributing | ||
|
||
1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md), which applies to all interactions in/with all Edera projects and venues. | ||
2. Before opening an issue or PR, please try a few searches to see if there is overlap with existing conversations or WIP contributions. | ||
3. For security or otherwise sensitive topics, please read our [Security Policy]. | ||
4. Ask questions! If you want to ask something, chances are someone else wants to ask it as well. | ||
|
||
## Contributing Code | ||
|
||
To get started with technical contributions, please read out [Development Guide]. If you're looking for something easy to tackle, [look for issues labeled `good first issue`][good-first-issue]. | ||
|
||
## Reporting bugs and other issues | ||
|
||
While it's totally fine to simply bring it up on our Discord, we encourage opening an issue on GitHub using the Bug Report template. | ||
|
||
## Pull Requests | ||
|
||
1. For anything more than simple bug/doc fixes, please open a GitHub issue for tracking purposes. | ||
- Else skip to step 3. | ||
2. Discuss the change with the teams to ensure we have consensus on the change being welcome. | ||
3. We encourage opening the PR sooner than later, and prefixing with `WIP:` so GitHub labels it as a Draft. | ||
4. Please include a detailed list of changes that the PR makes | ||
5. Once the PR is ready for review, remove the Draft status, and request a review from `edera-dev/engineering`. | ||
6. After the review cycle concludes and we know you are ready for merging, a team member will submit the PR to the merge queue. | ||
|
||
|
||
[Code of Conduct]: ./CODE_OF_CONDUCT.md | ||
[Security Policy]: ./SECURITY.md | ||
[Development Guide]: ./DEV.md | ||
[good-first-issues]: https://github.com/edera-dev/krata/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 |