Skip to content

Commit b7ddd67

Browse files
A few updates for the end of the year :)
- [X] Added support for Docker Instances ( thanks [mcoms](https://github.com/mcoms) ) - [X] Added GitHub Issue Templates and Project Documentation
1 parent d69e413 commit b7ddd67

15 files changed

+3202
-2771
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @manifestinteractive

.github/CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Contributing Guide
2+
===
3+
4+
Make sure you read and follow the instructions in the [pull request template](PULL_REQUEST_TEMPLATE.md). And note that all participation in this project (including code submissions) is
5+
governed by our [Code of Conduct](CODE_OF_CONDUCT.md).
6+
7+
Issues & Feature Requests
8+
---
9+
10+
[![Create Issue](https://img.shields.io/badge/Github-Create_Issue-red.svg?style=for-the-badge&logo=github&logoColor=ffffff&logoWidth=16)](https://github.com/manifestinteractive/teleprompter/issues/new/choose)
11+
12+
### Bug Fix
13+
14+
> We're sorry things are not working as expected, and want to get things fixed ASAP. In order to help us do that, we need a few things from you.
15+
16+
1. Create a [New Issue](https://github.com/manifestinteractive/teleprompter/issues/new/choose)
17+
2. Enter a Short but Descriptive Title for the Issue
18+
3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A`
19+
4. Look for the `Labels` section, and select `Bug Report` from the drop down menu
20+
5. Click `Submit new issue` button
21+
22+
### Feature Request
23+
24+
> Got an idea for a new feature? We'd love to hear it! In order to get this knocked out, we will need a few things from you.
25+
26+
1. Create a [New Issue](https://github.com/manifestinteractive/teleprompter/issues/new/choose)
27+
2. Enter a Short but Descriptive Title for the Feature Request
28+
3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A` ( you can delete the `Steps to Duplicate:` section as that does not apply )
29+
4. Look for the `Labels` section, and select `Feature Request` from the drop down menu
30+
5. Click `Submit new issue` button
31+
32+
Pull Requests
33+
---
34+
35+
[![Create Pull Request](https://img.shields.io/badge/Github-Create_Pull_Request-blue.svg?style=for-the-badge&logo=github&logoColor=ffffff&logoWidth=16)](https://github.com/manifestinteractive/teleprompter/compare)
36+
37+
### Bug Fix
38+
39+
> Each Bug Fix reported on GitHub should have its own `fix/*` branch. The branch name should be formatted `fix/###-issue-name` where `###` is the GitHub Issue Number, and `issue-name` is a 1-3 word summary of the issue.
40+
41+
1. Checkout latest `develop` branch
42+
2. Pull down the latest changes via `git pull`
43+
3. Create a new branch with the structure `fix/*`, e.g. `fix/123-broken-form`
44+
4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop`
45+
5. Tag your new Pull Request with `Ready for Code Review`
46+
47+
### Feature Request
48+
49+
> Each New Feature should reside in its own `feature/` branch. The branch name should be formatted `feature/###-feature-name` where `###` is the GitHub Issue Number, and `feature-name` is a 1-3 word summary of the feature.
50+
51+
1. Checkout latest `develop` branch
52+
2. Pull down the latest changes via `git pull`
53+
3. Create a new branch with the structure `feature/*`, e.g. `feature/123-mobile-header`
54+
4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop`
55+
5. Tag your new Pull Request with `Ready for Code Review`
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["Bug Report"]
5+
assignees:
6+
- manifestinteractive
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
- type: input
13+
id: contact
14+
attributes:
15+
label: Contact Details
16+
description: How can we get in touch with you if we need more info?
17+
placeholder: ex. [email protected]
18+
validations:
19+
required: false
20+
- type: textarea
21+
id: what-happened
22+
attributes:
23+
label: What happened?
24+
description: Describe the issue here.
25+
placeholder: Tell us what you see!
26+
value: "A bug happened!"
27+
validations:
28+
required: true
29+
- type: dropdown
30+
id: browsers
31+
attributes:
32+
label: What type of browser are you seeing the problem on?
33+
multiple: true
34+
options:
35+
- Firefox
36+
- Chrome
37+
- Safari
38+
- Microsoft Edge
39+
validations:
40+
required: true
41+
- type: dropdown
42+
id: operating-systems
43+
attributes:
44+
label: What type of Operating System are you seeing the problem on?
45+
multiple: true
46+
options:
47+
- Linux
48+
- Windows
49+
- Mac
50+
- Other
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: logs
55+
attributes:
56+
label: Code to produce this issue.
57+
description: Please copy and paste any relevant code to re-produce this issue. And the version of the browser you are using.
58+
render: shell
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Feature request
2+
description: Suggest an feature / idea for this project
3+
title: "[Feature Request / Suggestion]: "
4+
labels: ["Feature Request"]
5+
assignees:
6+
- manifestinteractive
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
We appreciate your feedback on how to improve this project. Please be sure to include as much details & any resources if possible!
12+
- type: textarea
13+
id: Suggestion
14+
attributes:
15+
label: Suggestion / Feature Request
16+
description: Describe the feature(s) you would like to see added.
17+
placeholder: Tell us your suggestion
18+
value: "Your suggestion here"
19+
validations:
20+
required: true
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Question
2+
description: I have a Question about this project
3+
labels: [Question]
4+
assignees:
5+
- manifestinteractive
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Question
10+
description: Please Write your Question Below.
11+
validations:
12+
required: true
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Requested Change
2+
description: This is a Requested Change to the project
3+
labels: [Requested Change]
4+
assignees:
5+
- manifestinteractive
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Describe the Problem
10+
description: Is your requested change related to a problem? Please describe.
11+
placeholder: A clear and concise description of what the request is.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Describe the Solution
17+
description: Describe the solution you'd like
18+
placeholder: A clear and concise description of what you want to happen.
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Alternatives
24+
description: Describe alternatives you've considered
25+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
26+
validations:
27+
required: false
28+
- type: textarea
29+
attributes:
30+
label: Additional Context
31+
description: |
32+
Add any other context or screenshots about the feature request here.
33+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
34+
validations:
35+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Overview
2+
---
3+
4+
TEXT
5+
6+
Reviewer
7+
---
8+
9+
> Where should the reviewer start? How to Test? Background Context? etc ( required )
10+
11+
TEXT
12+
13+
Checklist
14+
---
15+
16+
> I have tested each of the following, and they work as expected: ( required )
17+
18+
- [ ] Meets [Contributing Guide](https://github.com/manifestinteractive/teleprompter/blob/develop/.github/CONTRIBUTING.md) Requirements
19+
- [ ] Pulled in the Latest Code from the `develop` branch
20+
- [ ] Works on a Desktop / Laptop Device
21+
22+
Documentation
23+
---
24+
25+
> Screenshots, Attachments, Linked GitHub Issues, etc ( optional )
26+
27+
28+
29+
#### What GIF best describes this PR or how it makes you feel?
30+
31+
> Drag & Drop Something Fun Here ( optional )

.github/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
newIssueWelcomeComment: >
2+
Thanks for opening your first issue! Reports like these help improve the project!
3+
newPRWelcomeComment: >
4+
Thanks for opening this pull request!
5+
firstPRMergeComment: >
6+
Congrats on merging your first pull request!
7+
todo:
8+
keyword: '@todo'

.github/issue_label_bot.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
label-alias:
2+
bug: 'Bug Report'
3+
dependencies: 'Dependencies'
4+
feature_request: 'Feature Request'
5+
question: 'Question'

0 commit comments

Comments
 (0)