-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
84 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,19 @@ | ||
# 👥 Contributing | ||
> Guide on how to extend the turing-pi-js library | ||
## ℹ️ Overview | ||
|
||
- Project uses github-flow, start by forking the project | ||
- `main` is a stable branch with the latest changes | ||
- Once an issue is created and assigned to a developer, a feature branch is created | ||
- Work is performed in the feature branch then submitted as a Pull Request | ||
|
||
## 🔀 Flow Operations: | ||
|
||
1. Fork repository including all branches | ||
2. Creating a [new issue](https://github.com/PhearZero/turing-pi-js/issues/new) | ||
3. Submit PR with completed work to the original Feature Branch associated with the Issue | ||
|
||
## ⚙️ Building | ||
|
||
See the [README](../README.md) for basic details. |
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,28 @@ | ||
--- | ||
name: 🐛 Bug | ||
about: Library is not working as expected | ||
title: 'Fix: ' | ||
labels: 'bug' | ||
--- | ||
|
||
# ℹ Overview | ||
|
||
<!--- | ||
Explain the issue and the steps to reproduce the bug | ||
--> | ||
|
||
### 🤖 Turing Pi BMC | ||
<!-- Fill in the details of the table --> | ||
|
||
| Version | USB Mode | USB Node | SD Card | | ||
|---------|----------|----------|-------------------------------------------| | ||
| v0.1.0 | Device | Node1 | Amazon Basics microSDXC Memory Card 128GB | | ||
|
||
### 💾 Node information | ||
|
||
| Name | OS | SKU | Power | SD Card | | ||
|-------|------------------------|-----------|-------|-------------------------------------------| | ||
| Node1 | Ubuntu 20.04.5 x64 LTS | cm4108000 | On | Amazon Basics microSDXC Memory Card 128GB | | ||
| Node2 | Ubuntu 20.04.5 x64 LTS | cm4108000 | On | Amazon Basics microSDXC Memory Card 128GB | | ||
| Node3 | - | - | Off | | | ||
| Node4 | - | - | Off | | |
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,13 @@ | ||
--- | ||
name: 🎨 Chore | ||
about: Regular maintenance task | ||
title: 'Chore: ' | ||
labels: 'enhancement' | ||
--- | ||
|
||
# ℹ Overview | ||
|
||
<!--- | ||
Explain what needs to be cleaned up or changed to make the repository | ||
a better developer experience. | ||
--> |
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,12 @@ | ||
--- | ||
name: ✨ Feature | ||
about: Add a new feature to the library | ||
title: 'Feature: ' | ||
labels: 'enhancement' | ||
--- | ||
|
||
# ℹ Overview | ||
|
||
<!--- | ||
Explain what you would like to see added to Turing Pi JS | ||
--> |
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,12 @@ | ||
# ℹ Overview | ||
|
||
<!--- | ||
Explain the purposed changes | ||
--> | ||
|
||
### 📝 Issues and Pull Requests | ||
|
||
<!--- | ||
- fixes #1 | ||
- relates to #2 | ||
--> |