Skip to content

Commit 287cb84

Browse files
authored
chore: repo updates (#31)
1 parent f860864 commit 287cb84

3 files changed

Lines changed: 81 additions & 0 deletions

File tree

.github/BUG_TEMPLATE.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: 🐞 Bug
2+
description: File a bug/issue report
3+
title: "[BUG] <title>"
4+
labels: ["bug", "Needs Triage"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Current Behavior
16+
description: A concise description of the problem you are experiencing.
17+
validations:
18+
required: false
19+
- type: textarea
20+
attributes:
21+
label: Expected Behavior
22+
description: A concise description of what you expected to happen.
23+
validations:
24+
required: false
25+
- type: textarea
26+
attributes:
27+
label: Steps To Reproduce
28+
description: Steps to reproduce the behavior.
29+
placeholder: |
30+
1. In this environment...
31+
1. With this config...
32+
1. Run '...'
33+
1. See error...
34+
validations:
35+
required: false
36+
- type: textarea
37+
attributes:
38+
label: Environment
39+
description: |
40+
examples:
41+
- **OS**: Ubuntu 20.04
42+
- **OS**: MacOS 20.04
43+
- **OS**: Windows 11
44+
value: |
45+
- OS:
46+
render: markdown
47+
validations:
48+
required: false
49+
- type: textarea
50+
attributes:
51+
label: Anything else?
52+
description: |
53+
Links? References? Anything that will give us more context about the issue you are encountering!
54+
55+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
56+
validations:
57+
required: false

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Contributing
2+
3+
Contributions are welcome! As an open source project, any help we can get fixing bugs or adding features is always appreciated. In all cases, PRs will be reviewed with an eye toward future maintainability, so things like good comments, unit test coverage, and thorough design are importat considerations. If you decide to work on a bug or feature from our issue list, please be prepared to work through design or maintenance issues in the PR.
4+
5+
## Features
6+
7+
Please open an issue discussing your idea prior to beginning work on a pull request. We want to make sure that any work is directed in a way that is likely to be merged into master and ultimately shipped. Since any new feature adds maintenance effort, we have to be judicious with the features we accept.
8+
9+
## Bugs
10+
11+
If you have found a bug, please open an issue! If you have a fix, we'd love for you to include a PR that addresses the issue.

SECURITY.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Security Policy
2+
3+
Only patches or issues that effect the latest version of SharpFM will be addressed.
4+
5+
## Supported Versions
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 1.x | :white_check_mark: |
10+
11+
## Reporting a Vulnerability
12+
13+
For security related issues, please contact <https://github.com/fuzzzerd> directly with detailed information regarding the vulnerability or explot. If you have an associated change/fix, please include a .patch file or a description of how it can be fixed. If you'd like to open a PR with a fix that is also great, provided that does not directly expose an explit.

0 commit comments

Comments
 (0)