Chore/update information files (#25)

* Update LICENSE * Update README.md * Create CONTRIBUTING.md * Update CONTRIBUTING.md * Create PULL-REQUEST-TEMPLATE.md * Create BUG_REPORT.md * Create OTHER.md * Create QUESTION.md * Create RFC.md * Update CONTRIBUTING.md * Delete .github/ISSUE_TEMPLATE directory * Add files via upload
nrkno · Dec 14, 2023 · d5ad5cb · d5ad5cb
1 parent 8e8a439
commit d5ad5cb
Show file tree

Hide file tree

Showing 9 changed files with 237 additions and 7 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,50 @@
+name: Bug Report 🐛
+description: Use this if you've found a bug
+title: "Bug Report: [Short description of the bug]"
+labels:
+  - 🐛bug
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before you post, be sure to read our Contribution guidelines:
+        https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+
+  - type: textarea
+    attributes:
+      label: About me
+      description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+      placeholder: Example "This RFC is posted on behalf of the NRK."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Observed Behavior
+      description: What happened?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Version
+      description: What version of Sofie Core / Gateways / other components are you using?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Severity / Impact
+      description: How big of an issue is this? How does this limit your operations?
+      placeholder: |
+        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.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml
@@ -0,0 +1,27 @@
+name: Other Issue 🔧
+description: Use this for other issues
+title: "Other: [Short description of the issue]"
+labels:
+  - Other
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before you post, be sure to read our Contribution guidelines:
+        https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+
+  - type: textarea
+    attributes:
+      label: About me
+      description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+      placeholder: Example "This RFC is posted on behalf of the NRK."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Issue
+      description: Describe the issue below
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -0,0 +1,27 @@
+name: Question ❓
+description: Use this if you have a question to the Sofie team
+title: "Question: [Short summary of the question]"
+labels:
+  - ❓ Question
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before you post, be sure to read our Contribution guidelines:
+        https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+
+  - type: textarea
+    attributes:
+      label: About me
+      description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+      placeholder: Example "This RFC is posted on behalf of the NRK."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: My Question
+      description: Write your question below
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/rfc.yml b/.github/ISSUE_TEMPLATE/rfc.yml
@@ -0,0 +1,47 @@
+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
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before you post, be sure to read our Contribution guidelines:
+        https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
+
+  - type: textarea
+    attributes:
+      label: About me
+      description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
+      placeholder: Example "This RFC is posted on behalf of the NRK."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Use case
+      description: "Please write some background information here, such as: What is your use case? What problem are you trying to solve?"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Proposal
+      description: Please describe your proposal here
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Process
+      description: Please don't touch this section, the Sofie team will update this as the RFC progresses.
+      value: |
+        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
@@ -0,0 +1,56 @@
+<!--
+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."
+-->
+
+
+## Type of Contribution
+
+This is a: 
+<!-- (pick one) -->
+Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify)
+
+
+## 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?
+-->
+
+
+## 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.
diff --git a/CONTRIBUTING.md 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. The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License (MIT)
 
-Copyright (c) 2020 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

diff --git a/README.md b/README.md
@@ -1,12 +1,18 @@
-# Sofie: The Modern TV News Studio Automation System (code standard preset)
-
+# Sofie Code Standard Preset
 [![Node CI](https://github.com/nrkno/sofie-code-standard-preset/actions/workflows/node.yaml/badge.svg)](https://github.com/nrkno/sofie-code-standard-preset/actions/workflows/node.yaml)
 [![npm](https://img.shields.io/npm/v/@sofie-automation/code-standard-preset)](https://www.npmjs.com/package/@sofie-automation/code-standard-preset)
 
-This library is used in the [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/) for defining a code standard preset through [eslint](https://esling.org) and [prettier](https://prettier.io/).
+This is the _Sofie_ code standard preset library used in the [_**Sofie** TV Automation System_](https://github.com/nrkno/Sofie-TV-automation/) for defining a code standard preset through [_ESLint_](https://github.com/nrkno/sofie-eslint-plugin/) and [_Prettier_](https://prettier.io/).
 
 A script for checking compatible licenses is included.
 
+## 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)
+
+---
 ## Installation
 
 `yarn add --dev @sofie-automation/code-standard-preset`
@@ -139,9 +145,9 @@ module.exports = {
 
 **Remove** any other old linting or tsconfig files and refernces to them, for example a `config` folder containing `tsconfig...` files. These are no longer required.
 
-### Upgrade
+## Upgrade
 
-#### v2.0 to v2.1
+### v2.0 to v2.1
 
 This release introduces a simple replacement for `standard-version`
 
@@ -160,7 +166,7 @@ While you are here, try to update any `uses:` lines in the actions workflows, co
 - `actions/checkout@v3`
 - `actions/setup-node@v3`
 
-#### v0.4 to v0.5
+### v0.4 to v0.5
 
 This updates husky, and the config that goes with it.
 
@@ -169,3 +175,8 @@ Steps:
 - Create the `.husky/pre-commit` file
 - Remove the old husky config from `package.json`
 - Update the scripts and lint-staged config in `package.json`
+
+
+---
+
+_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._