From b17880c3c95271a5ae2d0395bcdd5c3e2d272955 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 22 Nov 2023 09:58:36 +0100 Subject: [PATCH 01/13] Update README.md --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9c2039419..f145ce9a9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,19 @@ -# 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. + +## Repository-specific Info for Developers +* [Developer Info](DEVELOPER.md) +* [Contribution Guidelines](CONTRIBUTING.md) + +## General Sofie System Info +* [Documentation](https://nrkno.github.io/sofie-core/) +* [Releases](https://nrkno.github.io/sofie-core/releases) + +*** ## Device support @@ -19,19 +28,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 +53,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 +135,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._ From 505415a99b4717d2f9a48a5308bfa62e76878957 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 22 Nov 2023 16:41:47 +0100 Subject: [PATCH 02/13] Create CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b893ada57 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +# 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. +* The **_releaseXX_** branches are our in-development branches. When a release is ready, we decide to “freeze” that branch and create a new **_releaseXX+1_** branch. + +We encourage you to base your contributions on the latest **releaseXX** branch, alternatively the **master** branch or a recently frozen **releaseXX** branch. The [Sofie Releases](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases. From 77c915d4a8cdef51a7e333a2814c4ab047600155 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 12:58:18 +0100 Subject: [PATCH 03/13] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 51 +++++++++++++++++++++++++++++--- 1 file changed, 47 insertions(+), 4 deletions(-) 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. From 29ccfce47363df8702cc818045f9012f5dea739f Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 13:17:35 +0100 Subject: [PATCH 04/13] Create BUG_REPORT.md --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 37 ++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md 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 + + From 81d5eee3bca689fa0a76ff923d9a872d2e15d8ce Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 13:46:01 +0100 Subject: [PATCH 05/13] Delete .github/ISSUE_TEMPLATE.md --- .github/ISSUE_TEMPLATE.md | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md 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.) From 13932f0059a9cfb5354c3d8ec7d5d9d334f4fc5a Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 13:57:58 +0100 Subject: [PATCH 06/13] Create OTHER.md --- .github/ISSUE_TEMPLATE/OTHER.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/OTHER.md 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 + From b83f27e460191ca027a7fd9a51ddaf26cf7a52a1 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 14:01:02 +0100 Subject: [PATCH 07/13] Create QUESTION.md --- .github/ISSUE_TEMPLATE/QUESTION.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/QUESTION.md 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 + From d067a0721c91a47da02ab152ad28c20451b49e37 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 14:07:41 +0100 Subject: [PATCH 08/13] Create RFC.md --- .github/ISSUE_TEMPLATE/RFC.md | 46 +++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/RFC.md 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. From 3ecf865097bf64d22e99b52e45831bdf1f55139c Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 14:26:50 +0100 Subject: [PATCH 09/13] Update LICENSE --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From e95ff8d3ff3364109a310dfcc182345cd5e1cf1f Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 14:31:21 +0100 Subject: [PATCH 10/13] Update README.md --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f145ce9a9..24236b861 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,13 @@ 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. -## Repository-specific Info for Developers -* [Developer Info](DEVELOPER.md) -* [Contribution Guidelines](CONTRIBUTING.md) - -## General Sofie System Info +### General Sofie System Info * [Documentation](https://nrkno.github.io/sofie-core/) * [Releases](https://nrkno.github.io/sofie-core/releases) +* [Contribution Guidelines](CONTRIBUTING.md) +* [License](LICENSE) -*** +--- ## Device support From a7a99b088bdf6ab21afb60cf2997a9e328fe456f Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 15:48:24 +0100 Subject: [PATCH 11/13] Update CONTRIBUTING.md --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b893ada57..392e0d8c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +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. +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. -* The **_releaseXX_** branches are our in-development branches. When a release is ready, we decide to “freeze” that branch and create a new **_releaseXX+1_** branch. -We encourage you to base your contributions on the latest **releaseXX** branch, alternatively the **master** branch or a recently frozen **releaseXX** branch. The [Sofie Releases](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases. +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. From 0728417913115412642ffb0960f186eca63e130e Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 16:06:29 +0100 Subject: [PATCH 12/13] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 392e0d8c2..242bfa8e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,4 +8,4 @@ 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. +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. From 108cc3442b25b726386aa1cb7b663541b2c89e52 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 4 Dec 2023 17:27:55 +0100 Subject: [PATCH 13/13] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 24236b861..a1e3ec228 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ 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 Info -* [Documentation](https://nrkno.github.io/sofie-core/) -* [Releases](https://nrkno.github.io/sofie-core/releases) +## 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) +* [License](LICENSE) ---