Skip to content
This repository was archived by the owner on Feb 20, 2024. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Github CODEOWNERS file

# Global code-owners for this repository
* @mattdean-digicatapult @jonmattgray @n3op2

helm/* @mattdean-digicatapult @dblane-digicatapult @jonmattgray @n3op2
* @digicatapult/software-engineering
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ about: Create a report to help us improve

<!--

Have you read DSCP's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/digicatapult/dscp-api/.github/blob/main/CODE_OF_CONDUCT.md
Have you read our Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/digicatapult/sqnc-api/.github/blob/main/CODE_OF_CONDUCT.md

-->

### Prerequisites

- [ ] Put an X between the brackets on this line if you have done all of the following:
- Checked the FAQs for common solutions: <https://github.com/digicatapult/dscp-api/blob/main/CONTRIBUTING.md/#FAQs>
- Checked that your issue isn't already filed: <https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Adscp-api>
- Checked the FAQs for common solutions: <https://github.com/digicatapult/sqnc-api/blob/main/CONTRIBUTING.md/#FAQs>
- Checked that your issue isn't already filed: <https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Asqnc-api>

### Description

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ about: Suggest an idea for this project

<!--

Have you read DSCP's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/digicatapult/dscp-api/.github/blob/main/CODE_OF_CONDUCT.md
Have you read our Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/digicatapult/sqnc-api/.github/blob/main/CODE_OF_CONDUCT.md

---
Also note that the Digital Catapult team has finite resources so it's unlikely that we'll work on feature requests. If we're interested in a particular feature however, we'll follow up and ask you to submit an RFC to talk about it in more detail.
Expand All @@ -22,7 +22,7 @@ Also note that the Digital Catapult team has finite resources so it's unlikely t

## Describe alternatives you've considered

<!-- A clear and concise description of the alternative solutions you've considered. Be sure to explain why DSCP's existing customisability isn't suitable for this feature. -->
<!-- A clear and concise description of the alternative solutions you've considered. Be sure to explain why the existing customisability isn't suitable for this feature. -->

## Additional context

Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Copy the correct template for your contribution

🐛 Are you fixing a bug? Copy the template from https://github.com/digicatapult/dscp-api/blob/main/.github/ISSUE_TEMPLATE/bug_report.md
💻 Are you changing functionality? Copy the template from https://github.com/digicatapult/dscp-api/blob/main/.github/ISSUE_TEMPLATE/feature_request.md
🐛 Are you fixing a bug? Copy the template from https://github.com/digicatapult/sqnc-api/blob/main/.github/ISSUE_TEMPLATE/bug_report.md
💻 Are you changing functionality? Copy the template from https://github.com/digicatapult/sqnc-api/blob/main/.github/ISSUE_TEMPLATE/feature_request.md
Replace this text with the contents of the template

Fill in all sections of the template
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@ jobs:
- name: Login to Dockerhub Registry
uses: docker/login-action@v2
with:
username: ${{ secrets.DSCP_DOCKERHUB_USERNAME }}
password: ${{ secrets.DSCP_DOCKERHUB_TOKEN }}
username: ${{ secrets.SQNC_DOCKERHUB_USERNAME }}
password: ${{ secrets.SQNC_DOCKERHUB_TOKEN }}
- name: Publish multi-arch image
uses: docker/build-push-action@v4
with:
Expand Down
44 changes: 22 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contributing to veritable-api
# Contributing to sequence-api

Firstly, we would like to thank you for taking the time to contribute!

The following is a set of guidelines for contributing to Veritable and its packages, which are hosted on the [digicatapult](https://github.com/digicatapult) organisation on GitHub. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.
The following is a set of guidelines for contributing to Sequence (SQNC) and its packages, which are hosted on the [digicatapult](https://github.com/digicatapult) organisation on GitHub. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.

#### Table Of Contents

Expand All @@ -24,7 +24,7 @@ The following is a set of guidelines for contributing to Veritable and its packa

## Code of Conduct

This project and all those participating in it are governed by the [Digital Catapult's Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=DSCP).
This project and all those participating in it are governed by the [Digital Catapult's Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=SQNC).

## FAQs

Expand All @@ -34,19 +34,19 @@ We don't have any frequently asked questions yet.

### Reporting Bugs

This section guides you through submitting a bug report for veritable-api. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behaviour :computer: :computer:, and find related reports :mag_right:.
This section guides you through submitting a bug report for sequence-api. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behaviour :computer: :computer:, and find related reports :mag_right:.

Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/digicatapult/dscp-api/blob/main/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster.
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/digicatapult/sqnc-api/blob/main/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster.

> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

#### Before Submitting A Bug Report

- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Adscp-api)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Asqnc-api)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.

#### How Do I Submit A (Good) Bug Report?

Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information by filling in [the template](https://github.com/digicatapult/dscp-api/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information by filling in [the template](https://github.com/digicatapult/sqnc-api/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).

Explain the problem and include additional details to help maintainers reproduce the problem:

Expand All @@ -56,30 +56,30 @@ Explain the problem and include additional details to help maintainers reproduce
- **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour.
- **Explain which behaviour you expected to see instead and why.**
- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, \*\*record the GIF with the [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/Xaviju/byzanzUI) on Linux.
- **If you're reporting that veritable-api crashed**, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in `Console.app` under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist.
- **If you're reporting that sequence-api crashed**, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in `Console.app` under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist.
- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

- **Did the problem start happening recently** (e.g. after updating to a new version of veritable-api) or was this always a problem?
- If the problem started happening recently, **can you reproduce the problem in an older version of veritable-api?** What's the most recent version in which the problem doesn't happen? You can checkout older versions of veritable-api from [the releases page](https://github.com/digicatapult/dscp-api/releases).
- **Did the problem start happening recently** (e.g. after updating to a new version of sequence-api) or was this always a problem?
- If the problem started happening recently, **can you reproduce the problem in an older version of sequence-api?** What's the most recent version in which the problem doesn't happen? You can checkout older versions of sequence-api from [the releases page](https://github.com/digicatapult/sqnc-api/releases).
- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

- **Which version of veritable-api are you using?** You can get the exact version from the version attribute within package.json.
- **What's the name and version of the OS you've deployed veritable-api to**?
- **Are you running veritable-api in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
- **Which version of sequence-api are you using?** You can get the exact version from the version attribute within package.json.
- **What's the name and version of the OS you've deployed sequence-api to**?
- **Are you running sequence-api in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for veritable-api, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
This section guides you through submitting an enhancement suggestion for sequence-api, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.

Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/digicatapult/dscp-api/blob/main/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed.
Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/digicatapult/sqnc-api/blob/main/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed.

#### Before Submitting An Enhancement Suggestion

- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Adscp-api)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Asqnc-api)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

#### How Do I Submit A (Good) Enhancement Suggestion?

Expand All @@ -89,19 +89,19 @@ Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com
- **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
- **Describe the current behaviour** and **explain which behaviour you expected to see instead** and why.
- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of veritable-api which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
- **Explain why this enhancement would be useful** to most veritable-api users.
- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of sequence-api which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
- **Explain why this enhancement would be useful** to most sequence-api users.
- **List some other text editors or applications where this enhancement exists.**
- **Specify which version of veritable-api you're using.** You can get the exact version from the version attribute within package.json.
- **What's the name and version of the OS you've deployed veritable-api to**?
- **Specify which version of sequence-api you're using.** You can get the exact version from the version attribute within package.json.
- **What's the name and version of the OS you've deployed sequence-api to**?

### Pull Requests

The process described here has several goals:

- Maintain veritable-api's quality
- Maintain sequence-api's quality
- Fix problems that are important to users
- Enable a sustainable system for veritable-api's maintainers to review contributions
- Enable a sustainable system for sequence-api's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

Expand Down
Loading