Merge pull request #158 from nrkno/chore/update-information-files

Updated information files

.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: ''
+
+---
+
+<!--
+Before you post, be sure to read our Contribution guidelines:
+https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+-->
+
+## About Me
+<!--
+Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+Example: "This issue is posted on behalf of the NRK."
+-->
+
+## Observed Behavior
+<!-- What happened? -->
+
+## Expected Behavior
+<!-- What did you expect to happen? -->
+
+## Version
+<!-- What version of Sofie Core / Gateways / other components are you using? -->
+
+## Severity / Impact
+<!--
+How big of an issue is this? How does this limit your operations?
+Examples:
+* This is a blocker for us, we cannot use feature X until this is fixed.
+* Not a big issue for us, but it would be nice to have this fixed.
+ -->
+

.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: ''
+
+---
+
+<!--
+Before you post, be sure to read our Contribution guidelines:
+https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+-->
+
+## About Me
+<!--
+Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+Example: "This issue is posted on behalf of the NRK."
+-->
+
+## Issue
+<!-- Describe the issue below -->

.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: ''
+
+---
+
+<!--
+Before you post, be sure to read our Contribution guidelines:
+https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+-->
+
+## About Me
+<!--
+Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+Example: "This issue is posted on behalf of the NRK."
+-->
+
+## My Question
+<!-- Write your question below. -->

.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: ''
+
+---
+
+<!--
+Before you post, be sure to read our Contribution guidelines:
+https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+-->
+
+## About Me
+<!--
+Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+Example: "This RFC is posted on behalf of the NRK."
+-->
+
+## Background
+<!--
+Please write some background information here, such as:
+What is your use case?
+What problem are you trying to solve?
+-->
+
+
+## Proposal
+<!--
+Please describe your proposal here:
+-->
+
+
+## Status
+<!--
+Please don't touch this section, the Sofie team will update this as the RFC progresses.
+-->
+
+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.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,56 @@
-* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
+<!--
+Before you open a PR, be sure to read our Contribution guidelines:
+https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+-->
 
+## About the Contributor
+<!--
+Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+Example: "This pull request is posted on behalf of the NRK."
+-->
 
 
-* **What is the current behavior?** (You can also link to an open issue here)
+## Type of Contribution
 
+This is a: 
+<!-- (pick one) -->
+Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify)
 
 
-* **What is the new behavior (if this is a feature change)?**
+## Current Behavior
+<!--
+Please describe how things worked before this PR.
+If it's a bug fixe: Describe the bug (what was happening?)
+-->
 
 
+## New Behavior
+<!--
+What is the new behavior?
+-->
 
-* **Other information**:
+
+## Testing Instructions
+<!--
+Please provide some instructions and other information for how to verify that the feature works.
+Examples:
+* "Do a Take for a part that contains an adlib, verify that the adlib plays out."
+* "Open the Switchboard panel and toggle a route, verify that the route toggles in the GUI."
+* "This feature also affects 'feature X', so that needs to be tested for regressions as well."
+-->
+
+
+## Other Information
+<!-- The more information you can provide, the easier the pull request will be to merge -->
+
+
+## Status
+<!--
+Before you open the PR, make sure the items below are done.
+If they're not, please open the PR as a Draft.
+-->
+
+- [ ] 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.

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.

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

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._