Skip to content

Commit

Permalink
GitHub templates, code of conduct, security, and CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DamianSuess committed Sep 7, 2024
1 parent a231eae commit a89aecf
Show file tree
Hide file tree
Showing 6 changed files with 105 additions and 3 deletions.
39 changes: 39 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,42 @@ If you don't have a known good BLE device that's easy to use for testing, consid
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.

Also see the [README's Tips](../README.md#tips).

## Overview

Linux.Bluetooth is an open-source project. We encourage community members like yourself to contribute.

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.

Issues posted without a description may be closed immediately. Use the discussion boards if you have a question, not Issues.

We will close your _PR_ if it doesn't have an approved issue / feature request.

We reserve the right to close your "_issue_" or feature request if:

* It's an inquiry, not an issue.
* Error in your code for not following the documentation
* Not providing a description and steps to reproduce
* Not providing a sample when asked to do so

## "Keep It Simple Sally"

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_.

## Branching Strategy

Below is a basic branching hierarchy and strategy.

| Branch | Purpose
|-|-|
| `master` | All releases are tagged published using the `master` branch
| `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.
| `feature/*` | New feature branch. Once completed, it is merged into `develop` and the branch must be deleted.
| `stable/*` | Stable release base build which shares cherry-picked merges from `develop`. This branch **must not** be deleted.

## Regards

> Thank you,
>
> Damian Suess<br />
> Xeno Innovations, Inc. / Suess Labs
16 changes: 16 additions & 0 deletions .github/Code-of-Conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Code of Conduct

## Our Pledge

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.

## Our Standards

* Focus on what is best to improve the project's codebase
* Give constructive feedback
* Be respectful towards one another
* Feedback is welcome
* Jokes are welcomed - _don't like it, rub dirt on it_
* _Keep political views out of code_

After all, we're all human.. _except for AI, that's just an algorithm_.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Feature request
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: ''
title: "[Enhancement] "
labels: enhancement, not-reviewed
assignees: ''

---
Expand Down
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Issue
about: Create a report to help us improve
title: "[Issue] "
labels: enhancement
assignees: ''

---

## Description
A clear and concise description of what the bug is and include samples (using code blocks) if applicable.

## Environment
* **OS:** _Windows 10, Ubuntu 22.04, etc._
* **Prism.Avalonia Version:**
* **Avalonia Version:**

## Severity (1-5)
1=Low (_annoyance_), 5=High (_crashes visual studio_)

## Steps To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. Error message '...'

## Expected Behavior
A clear and concise description of what you expected to happen.

## Screenshots
If applicable, add screenshots to help explain your problem.

## Additional context
Add any other context about the problem here.
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Details

_REMOVE ME: Descritpion of PR. If you don't provide a full description, we will cancel this PR._

## Linked To Issue/Feature

* #XXXX - _issue/discussion_

_REMOVE ME: Remember to link to issue/discussion post number_
3 changes: 3 additions & 0 deletions .github/Security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Security

Report issues via the discussion boards

0 comments on commit a89aecf

Please sign in to comment.