Skip to content

Commit a89aecf

Browse files
committed
GitHub templates, code of conduct, security, and CONTRIBUTING.md
1 parent a231eae commit a89aecf

File tree

6 files changed

+105
-3
lines changed

6 files changed

+105
-3
lines changed

.github/CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,42 @@ If you don't have a known good BLE device that's easy to use for testing, consid
1414
You can create a virtual device like a Polar HR Sensor in the app. Then use the manual test to connect to the virtual device and read GATT characteristics.
1515

1616
Also see the [README's Tips](../README.md#tips).
17+
18+
## Overview
19+
20+
Linux.Bluetooth is an open-source project. We encourage community members like yourself to contribute.
21+
22+
You can contribute today by creating a **feature request**, **issue**, or **discussion** on the forum. From there we can have a brief discussion as to where this fits into the backlog priority. If this is something that fits within the architecture, we'll kindly ask you to create a **Pull Request**. Any PR made without first having an issue/discussion may be closed.
23+
24+
Issues posted without a description may be closed immediately. Use the discussion boards if you have a question, not Issues.
25+
26+
We will close your _PR_ if it doesn't have an approved issue / feature request.
27+
28+
We reserve the right to close your "_issue_" or feature request if:
29+
30+
* It's an inquiry, not an issue.
31+
* Error in your code for not following the documentation
32+
* Not providing a description and steps to reproduce
33+
* Not providing a sample when asked to do so
34+
35+
## "Keep It Simple Sally"
36+
37+
There have been requests in the past where individuals wanted changes for the sake of personal ease rather than how it would affect the ecosystem compatibility. This project should maintain compatibility with Linux distros supported by .NET, be careful of _one-offs_.
38+
39+
## Branching Strategy
40+
41+
Below is a basic branching hierarchy and strategy.
42+
43+
| Branch | Purpose
44+
|-|-|
45+
| `master` | All releases are tagged published using the `master` branch
46+
| `develop` | The **default** & active development branch. When a feature set is completed and ready for public release, the `develop` branch will be merged into `master` and a new NuGet package will be published.
47+
| `feature/*` | New feature branch. Once completed, it is merged into `develop` and the branch must be deleted.
48+
| `stable/*` | Stable release base build which shares cherry-picked merges from `develop`. This branch **must not** be deleted.
49+
50+
## Regards
51+
52+
> Thank you,
53+
>
54+
> Damian Suess<br />
55+
> Xeno Innovations, Inc. / Suess Labs

.github/Code-of-Conduct.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation and knowledge readily available to others. We inspire everyone to learn from one another, to share ideas, and help grow the community.
6+
7+
## Our Standards
8+
9+
* Focus on what is best to improve the project's codebase
10+
* Give constructive feedback
11+
* Be respectful towards one another
12+
* Feedback is welcome
13+
* Jokes are welcomed - _don't like it, rub dirt on it_
14+
* _Keep political views out of code_
15+
16+
After all, we're all human.. _except for AI, that's just an algorithm_.

.github/ISSUE_TEMPLATE/feature_request.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
name: Feature request
2+
name: Feature Request
33
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
4+
title: "[Enhancement] "
5+
labels: enhancement, not-reviewed
66
assignees: ''
77

88
---

.github/ISSUE_TEMPLATE/issue.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Issue
3+
about: Create a report to help us improve
4+
title: "[Issue] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
A clear and concise description of what the bug is and include samples (using code blocks) if applicable.
12+
13+
## Environment
14+
* **OS:** _Windows 10, Ubuntu 22.04, etc._
15+
* **Prism.Avalonia Version:**
16+
* **Avalonia Version:**
17+
18+
## Severity (1-5)
19+
1=Low (_annoyance_), 5=High (_crashes visual studio_)
20+
21+
## Steps To Reproduce
22+
Steps to reproduce the behavior:
23+
1. Go to '...'
24+
2. Click on '...'
25+
3. Scroll down to '...'
26+
4. Error message '...'
27+
28+
## Expected Behavior
29+
A clear and concise description of what you expected to happen.
30+
31+
## Screenshots
32+
If applicable, add screenshots to help explain your problem.
33+
34+
## Additional context
35+
Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Details
2+
3+
_REMOVE ME: Descritpion of PR. If you don't provide a full description, we will cancel this PR._
4+
5+
## Linked To Issue/Feature
6+
7+
* #XXXX - _issue/discussion_
8+
9+
_REMOVE ME: Remember to link to issue/discussion post number_

.github/Security.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Security
2+
3+
Report issues via the discussion boards

0 commit comments

Comments
 (0)