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

Updated information files

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -1,7 +1,7 @@
 ---
-name: Bug report
-about: Use this if you have a problem with Sofie
-title: "Bug report: [Short description of the bug]"
+name: Bug Report
+description: Use this if you've found a bug
+title: "Bug Report: [Short description of the bug]"
 labels: 🐛bug
 assignees: ''
 
@@ -12,16 +12,16 @@ Before you post, be sure to read our Contribution guidelines:
 https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
 -->
 
-## About me
+## About Me
 <!--
-Tell us who / which organization you are representing.
-Example: This PR is contributed by NRK
+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
+## Observed Behavior
 <!-- What happened? -->
 
-## Expected behavior
+## Expected Behavior
 <!-- What did you expect to happen? -->
 
 ## Version
@@ -35,5 +35,3 @@ Examples:
 * Not a big issue for us, but it would be nice to have this fixed.
  -->
 
-
-

.github/ISSUE_TEMPLATE/OTHER.md

@@ -1,8 +1,8 @@
 ---
-name: Other
-about: Use this for anything else
-title: ""
-labels: ""
+name: Other Issue
+description: Use this for other issues
+title: "Other: [Short description of the issue]"
+labels: "Other"
 assignees: ''
 
 ---
@@ -12,12 +12,11 @@ Before you post, be sure to read our Contribution guidelines:
 https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
 -->
 
-## About me
+## About Me
 <!--
-Tell us who / which organization you are representing.
-Example: This PR is contributed by NRK
+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
-<!-- Write below -->
-
+<!-- Describe the issue below -->

.github/ISSUE_TEMPLATE/QUESTION.md

@@ -1,7 +1,7 @@
 ---
 name: Question
-about: Use this if you have a question to ask
-title: ""
+description: Use this if you have a question to the Sofie team
+title: "Question: [Short summary of the question]"
 labels: ❓ Question
 assignees: ''
 
@@ -12,12 +12,11 @@ Before you post, be sure to read our Contribution guidelines:
 https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
 -->
 
-## About me
+## About Me
 <!--
-Tell us who / which organization you are representing.
-Example: This PR is contributed by NRK
+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
+## My Question
 <!-- Write your question below. -->
-

.github/ISSUE_TEMPLATE/RFC.md

@@ -1,7 +1,7 @@
 ---
-name: Request for comments
-about: Use this to initiate a discussion about a new feature or a larger change
-title: "RFC: [Short description of the feature]"
+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: ''
 
@@ -12,18 +12,23 @@ 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:
-Who are you representing?
+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
+Please describe your proposal here:
 -->
 
 
@@ -32,15 +37,10 @@ Please describe your proposal here
 Please don't touch this section, the Sofie team will update this as the RFC progresses.
 -->
 
-This is an RFC - Request for comments (see our
-[Contribution guidelines](https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines) ).
-
 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,60 +1,55 @@
-
 <!--
 Before you open a PR, be sure to read our Contribution guidelines:
 https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
 -->
 
-## The contributor
+## About the Contributor
 <!--
-Tell us who / which organization you are representing.
-Example: This PR is contributed by NRK
+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."
 -->
 
-## Type of contribution
-<!-- Pick one by marking it with an "x" -->
 
-This is a
+## Type of Contribution
 
-- [ ] Bug fix
-- [ ] Feature
-- [ ] Code improvement
-- [ ] Documentation improvement
-- [ ] Other (please specify)
+This is a: 
+<!-- (pick one) -->
+Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify)
 
 
-## Current behavior
+## Current Behavior
 <!--
 Please describe how things worked before this PR.
 If it's a bug fixe: Describe the bug (what was happening?)
 -->
 
 
-## New behavior
+## New Behavior
 <!--
 What is the new behavior?
 -->
 
 
-## Test instructions
+## 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 view 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.
+* "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
-
+## 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
+- [ ] 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

@@ -7,6 +7,6 @@ Before contributing to this specific repository, please read the [Contribution G
 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.
+* The **_develop_** branch is our in-development branch. When a release is ready, we decide to “freeze” that branch and merge it into **_master_** 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 **_develop_** branch. The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases.

LICENSE

@@ -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

README.md

@@ -1,14 +1,12 @@
 # Sofie Input Gateway
 
-This is the _Input Gateway_ of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/), used to pipe user input into the [Core](https://github.com/nrkno/tv-automation-server-core).
+This is the _Input Gateway_ of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/), used to pipe user input into the [_Sofie Core_](https://github.com/nrkno/sofie-core).
 
-## Repository-specific Info for Developers
-* [Developer Info](DEVELOPER.md)
+## 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)
-
-## General Sofie System Info
-* [Documentation](https://nrkno.github.io/sofie-core/)
-* [Releases](https://nrkno.github.io/sofie-core/releases)
+* [License](LICENSE)
 
 ---