diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 3b7c28f10..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,11 +0,0 @@ -* **I'm submitting a ...** -[ ] bug report -[ ] feature request -[ ] question about the decisions made in the repository -[ ] question about how to use this project - -* **Summary** - - - -* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 000000000..c4a6b41f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,37 @@ +--- +name: Bug Report +description: Use this if you've found a bug +title: "Bug Report: [Short description of the bug]" +labels: 🐛bug +assignees: '' + +--- + + + +## About Me + + +## Observed Behavior + + +## Expected Behavior + + +## Version + + +## Severity / Impact + + diff --git a/.github/ISSUE_TEMPLATE/OTHER.md b/.github/ISSUE_TEMPLATE/OTHER.md new file mode 100644 index 000000000..9b597cd7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/OTHER.md @@ -0,0 +1,22 @@ +--- +name: Other Issue +description: Use this for other issues +title: "Other: [Short description of the issue]" +labels: "Other" +assignees: '' + +--- + + + +## About Me + + +## Issue + diff --git a/.github/ISSUE_TEMPLATE/QUESTION.md b/.github/ISSUE_TEMPLATE/QUESTION.md new file mode 100644 index 000000000..39d6f48fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.md @@ -0,0 +1,22 @@ +--- +name: Question +description: Use this if you have a question to the Sofie team +title: "Question: [Short summary of the question]" +labels: ❓ Question +assignees: '' + +--- + + + +## About Me + + +## My Question + diff --git a/.github/ISSUE_TEMPLATE/RFC.md b/.github/ISSUE_TEMPLATE/RFC.md new file mode 100644 index 000000000..4cc485cd5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/RFC.md @@ -0,0 +1,46 @@ +--- +name: Request for Comments +description: Use this to initiate a discussion about a new feature or a larger change +title: "RFC: [Short description of the feature/change]" +labels: RFC, Contribution +assignees: '' + +--- + + + +## About Me + + +## Background + + + +## Proposal + + + +## Status + + +The Sofie Team will evaluate this RFC and open up a discussion about it, usually within a week. + +- [x] RFC created +- [ ] Sofie Team has evaluated the RFC +- [ ] A workshop has been planned +- [ ] RFC has been discussed in a workshop +- [ ] A conclusion has been reached, see comments in thread. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index caae6b13d..92803e9d9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,56 @@ -* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) + +## About the Contributor + -* **What is the current behavior?** (You can also link to an open issue here) +## Type of Contribution +This is a: + +Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify) -* **What is the new behavior (if this is a feature change)?** +## Current Behavior + +## New Behavior + -* **Other information**: + +## Testing Instructions + + + +## Other Information + + + +## Status + + +- [ ] PR is ready to be reviewed. +- [ ] The functionality has been tested by the author. +- [ ] Relevant unit tests has been added / updated. +- [ ] Relevant documentation (code comments, [system documentation](https://nrkno.github.io/sofie-core/)) has been added / updated. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..242bfa8e2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# How to Contribute to this Repository + +Before contributing to this specific repository, please read the [Contribution Guidelines](https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines) for the _Sofie_ project. + + +## Branches +This repository uses the following branches: + +* **_master_** is our main branch. We consider it stable and it is used in production. + +We encourage you to base your contributions on the latest **_master_** branch of this repository. The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the _Sofie_ releases. diff --git a/LICENSE b/LICENSE index 41b71f877..3a47b46a6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018 Norsk rikskringkasting AS +Copyright (c) 2023 Norsk rikskringkasting AS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 9c2039419..a1e3ec228 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ -# Sofie: The Modern TV News Studio Automation System (ATEM connection library) - +# Sofie ATEM Connection Library [![Node CI](https://github.com/nrkno/sofie-atem-connection/actions/workflows/node.yaml/badge.svg)](https://github.com/nrkno/sofie-atem-connection/actions/workflows/node.yaml) [![codecov](https://codecov.io/gh/nrkno/sofie-atem-connection/branch/master/graph/badge.svg)](https://codecov.io/gh/nrkno/sofie-atem-connection/) [![npm](https://img.shields.io/npm/v/atem-connection)](https://www.npmjs.com/package/atem-connection) -This library is used in the [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/) for connecting to Blackmagic Design ATEM devices. +This is the _ATEM Connection_ library of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/). The library is used for connecting to Blackmagic Design's ATEM devices. + +## General Sofie System Information +* [_Sofie_ Documentation](https://nrkno.github.io/sofie-core/) +* [_Sofie_ Releases](https://nrkno.github.io/sofie-core/releases) +* [Contribution Guidelines](CONTRIBUTING.md) +* [License](LICENSE) + +--- ## Device support @@ -19,19 +26,17 @@ Additionally any newly unimplemented functionality will generally only be writte We have no intention of dropping support for older firmwares, but we may do at some point. If we do this will be done in a major version bump, and will only be for significantly older firmware. -It is tested on a variety of models spanning every generation, and the aim is to provide support for every model. +The library is tested on a variety of models spanning every generation, and the aim is to provide support for every model. Note: USB control of devices is not supported by this library. -## Technology highlights - +## Technology Highlights - Typescript - Jest - standard-version - codecov ## Installation - For usage by library consumers installation is as easy as: ```sh @@ -46,7 +51,7 @@ yarn yarn build ``` -We welcome any contributions. Please read [our guide](.github/CONTRIBUTING.md) on how to add new commands before raising a PR. +We welcome any contributions. Please read [our guide](CONTRIBUTING.md) on how to add new commands before raising a PR. ## Usage @@ -128,4 +133,8 @@ This module run tests with jest. $ yarn unit ``` -There is a suite of generated serialization tests, using [atem-connection-test-generator](https://github.com/LibAtem/atem-connection-test-generator) as the [LibAtem](https://github.com/LibAtem) project has tests to verify its serialization against the Blackmagic Atem SDK +There is a suite of generated serialization tests, using [atem-connection-test-generator](https://github.com/LibAtem/atem-connection-test-generator) as the [LibAtem](https://github.com/LibAtem) project has tests to verify its serialization against the Blackmagic Design's ATEM SDK. + +--- + +_The NRK logo is a registered trademark of Norsk rikskringkasting AS. The license does not grant any right to use, in any way, any trademarks, service marks or logos of Norsk rikskringkasting AS._