nrkno · nytamin · Dec 5, 2023 · Nov 22, 2023 · Nov 22, 2023 · Dec 4, 2023
@@ -0,0 +1,38 @@
+---
+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.
+ -->
+
+
@@ -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 -->
@@ -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. -->
@@ -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.
@@ -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.
@@ -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.
@@ -1,6 +1,6 @@
 MIT License (MIT)
 
-Copyright (c) 2018 Norsk rikskringkasting AS (NRK)
+Copyright (c) 2023 Norsk rikskringkasting AS (NRK)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

@@ -1,17 +1,19 @@
-# Sofie: The Modern TV News Studio Automation System (Timeline State Resolver TSR library)
-
+# Sofie Timeline State Resolver (TSR) 
 [![Node CI](https://github.com/nrkno/sofie-timeline-state-resolver/actions/workflows/node.yaml/badge.svg)](https://github.com/nrkno/sofie-timeline-state-resolver/actions/workflows/node.yaml)
 [![codecov](https://codecov.io/gh/nrkno/sofie-timeline-state-resolver/branch/master/graph/badge.svg)](https://codecov.io/gh/nrkno/sofie-timeline-state-resolver)
 
-This is a part of the [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/).
+This is the _Timeline State Resolver (TSR)_ library, part of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/). This library orchestrates and controls different devices. Its input is a [timeline](https://github.com/SuperFlyTV/supertimeline) data structure and a layer-to-device-map.
+Using this input, it resolves the expected state, diffs the state against current state, and sends commands to devices where necessary.
 
-## Abstract
+## 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)
 
-This library orchestrates and controls different devices.
-Its input is a [timeline](https://github.com/SuperFlyTV/supertimeline) data structure and a layer-to-device-map.
-Using the input, it resolves the expected state, diffs the state against current state and sends commands to devices where necessary.
+---
 
-## Supported devices
+## Supported Devices
 
 - **[CasparCG](http://casparcg.com/)** - using the [casparcg-connection](https://github.com/SuperFlyTV/casparcg-connection) library
 - **Blackmagic Design ATEM** vision mixers - using the [atem-connection](https://github.com/nrkno/tv-automation-atem-connection) library
@@ -50,6 +52,10 @@ Note, that your IDE may not pick up your new type definitions until you build th
 
 There is a test application [quick-tsr](/packages/quick-tsr) inside this repository which can be used to easily test changes made to this library.
 
-### Working with types
+### Working with Types
 
 Types that need to be consumed by external systems that have no need to interact with the TSR library itself should be written in the timeline-state-resolver-types package. Some types will be generated from JSON schemas, the schemas are composed under the $schemas subfolder in the specific integration's subfolder. (See the abstract integration for an example). The types can be generated with the `yarn generate-schema-types` command. The schemas themselves must be exported from the `src/manifests.ts` file, so they can be used by external systems to validate payloads and generate UI's.
+
+---
+
+_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._