-
-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
d69e413
commit b7ddd67
Showing
15 changed files
with
3,202 additions
and
2,771 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 @@ | ||
* @manifestinteractive |
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,73 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
education, socio-economic status, nationality, personal appearance, race, | ||
religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org |
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,55 @@ | ||
Contributing Guide | ||
=== | ||
|
||
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 | ||
governed by our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
||
Issues & Feature Requests | ||
--- | ||
|
||
[](https://github.com/manifestinteractive/teleprompter/issues/new/choose) | ||
|
||
### Bug Fix | ||
|
||
> 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. | ||
1. Create a [New Issue](https://github.com/manifestinteractive/teleprompter/issues/new/choose) | ||
2. Enter a Short but Descriptive Title for the Issue | ||
3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A` | ||
4. Look for the `Labels` section, and select `Bug Report` from the drop down menu | ||
5. Click `Submit new issue` button | ||
|
||
### Feature Request | ||
|
||
> 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. | ||
1. Create a [New Issue](https://github.com/manifestinteractive/teleprompter/issues/new/choose) | ||
2. Enter a Short but Descriptive Title for the Feature Request | ||
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 ) | ||
4. Look for the `Labels` section, and select `Feature Request` from the drop down menu | ||
5. Click `Submit new issue` button | ||
|
||
Pull Requests | ||
--- | ||
|
||
[](https://github.com/manifestinteractive/teleprompter/compare) | ||
|
||
### Bug Fix | ||
|
||
> 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. | ||
1. Checkout latest `develop` branch | ||
2. Pull down the latest changes via `git pull` | ||
3. Create a new branch with the structure `fix/*`, e.g. `fix/123-broken-form` | ||
4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop` | ||
5. Tag your new Pull Request with `Ready for Code Review` | ||
|
||
### Feature Request | ||
|
||
> 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. | ||
1. Checkout latest `develop` branch | ||
2. Pull down the latest changes via `git pull` | ||
3. Create a new branch with the structure `feature/*`, e.g. `feature/123-mobile-header` | ||
4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop` | ||
5. Tag your new Pull Request with `Ready for Code Review` |
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,58 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "[Bug]: " | ||
labels: ["Bug Report"] | ||
assignees: | ||
- manifestinteractive | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: Describe the issue here. | ||
placeholder: Tell us what you see! | ||
value: "A bug happened!" | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: What type of browser are you seeing the problem on? | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: operating-systems | ||
attributes: | ||
label: What type of Operating System are you seeing the problem on? | ||
multiple: true | ||
options: | ||
- Linux | ||
- Windows | ||
- Mac | ||
- Other | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Code to produce this issue. | ||
description: Please copy and paste any relevant code to re-produce this issue. And the version of the browser you are using. | ||
render: shell |
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,20 @@ | ||
name: Feature request | ||
description: Suggest an feature / idea for this project | ||
title: "[Feature Request / Suggestion]: " | ||
labels: ["Feature Request"] | ||
assignees: | ||
- manifestinteractive | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
We appreciate your feedback on how to improve this project. Please be sure to include as much details & any resources if possible! | ||
- type: textarea | ||
id: Suggestion | ||
attributes: | ||
label: Suggestion / Feature Request | ||
description: Describe the feature(s) you would like to see added. | ||
placeholder: Tell us your suggestion | ||
value: "Your suggestion here" | ||
validations: | ||
required: true |
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: Question | ||
description: I have a Question about this project | ||
labels: [Question] | ||
assignees: | ||
- manifestinteractive | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Question | ||
description: Please Write your Question Below. | ||
validations: | ||
required: true |
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,35 @@ | ||
name: Requested Change | ||
description: This is a Requested Change to the project | ||
labels: [Requested Change] | ||
assignees: | ||
- manifestinteractive | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Describe the Problem | ||
description: Is your requested change related to a problem? Please describe. | ||
placeholder: A clear and concise description of what the request is. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Describe the Solution | ||
description: Describe the solution you'd like | ||
placeholder: A clear and concise description of what you want to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Alternatives | ||
description: Describe alternatives you've considered | ||
placeholder: A clear and concise description of any alternative solutions or features you've considered. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Additional Context | ||
description: | | ||
Add any other context or screenshots about the feature request here. | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
validations: | ||
required: false |
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,31 @@ | ||
Overview | ||
--- | ||
|
||
TEXT | ||
|
||
Reviewer | ||
--- | ||
|
||
> Where should the reviewer start? How to Test? Background Context? etc ( required ) | ||
TEXT | ||
|
||
Checklist | ||
--- | ||
|
||
> I have tested each of the following, and they work as expected: ( required ) | ||
- [ ] Meets [Contributing Guide](https://github.com/manifestinteractive/teleprompter/blob/develop/.github/CONTRIBUTING.md) Requirements | ||
- [ ] Pulled in the Latest Code from the `develop` branch | ||
- [ ] Works on a Desktop / Laptop Device | ||
|
||
Documentation | ||
--- | ||
|
||
> Screenshots, Attachments, Linked GitHub Issues, etc ( optional ) | ||
|
||
|
||
#### What GIF best describes this PR or how it makes you feel? | ||
|
||
> Drag & Drop Something Fun Here ( optional ) |
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,8 @@ | ||
newIssueWelcomeComment: > | ||
Thanks for opening your first issue! Reports like these help improve the project! | ||
newPRWelcomeComment: > | ||
Thanks for opening this pull request! | ||
firstPRMergeComment: > | ||
Congrats on merging your first pull request! | ||
todo: | ||
keyword: '@todo' |
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,5 @@ | ||
label-alias: | ||
bug: 'Bug Report' | ||
dependencies: 'Dependencies' | ||
feature_request: 'Feature Request' | ||
question: 'Question' |
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 |
---|---|---|
|
@@ -7,4 +7,5 @@ syntax: glob | |
Thumbs.db | ||
.idea | ||
*.log | ||
node_modules | ||
node_modules | ||
!.nvmrc |
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.12.0 |
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
Oops, something went wrong.