Merge pull request #75 from alan-turing-institute/prettier

Add linting workflow

.github/ISSUE_TEMPLATE/Story-big-goals-issue.md

@@ -1,29 +1,33 @@
 ---
-name: 'Story: Big goals issue'
+name: "Story: Big goals issue"
 about: Issue of issues for longer than a month tasks
-title: ''
+title: ""
 labels: Story
-assignees: ''
-
+assignees: ""
 ---
 
 # Goal Title
+
 What will this work achieve?
 
 ## Description
+
 Specific aims
 
 ## Definition of Done
+
 When will this be considered as succesfully completed?
 
 ## Details
+
 - RACI
   - Accountable team or person:
   - Responsible team or person:
   - Informed and consulted people:
 - Estimated effort in total FTE:
 
 ## Task and issue breakdown
+
 Breakdown in specific tasks of maximum a month duration, tasks and issues may be added as necessary
 Issues may span across repositories when necessary
 
@@ -34,8 +38,9 @@ Issues may span across repositories when necessary
 - issue sa-tre/satre-team#X
 
 ## Checklist
+
 - [ ] This Story have been agreed with project members, it tackles prioritised work
-  - [ ] If not: Label as ForPrioritisation so it discussed in the next monthly meeting, do not set a status  
+  - [ ] If not: Label as ForPrioritisation so it discussed in the next monthly meeting, do not set a status
 - [ ] I have filled in the Team Accountabe field
 - [ ] I have included this Story in the agreed upon Milestone, set status as Planned
   - [ ] If not: set status as Backlog, to be Planned via weekly meetings or async discussions

.github/ISSUE_TEMPLATE/monthly-report.md

@@ -1,10 +1,7 @@
 ---
 name: Monthly Report
 about: Issue to communicate progress for Monthly meeting, a PR may be associated
-title: ''
+title: ""
 labels: Management
 assignees: Davsarper
-
 ---
-
-

.github/workflows/lint.yaml

@@ -0,0 +1,18 @@
+name: Lint
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+job:
+  prettier:
+    name: Prettier
+    steps:
+      - name: Checkout-repository
+        uses: actions/checkout@v4
+
+      - name: Run prettier
+      - uses: pre-commit/[email protected]
+        with:
+          extra_args: prettier

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier

.prettierignore

@@ -0,0 +1 @@
+LICENSE

README.md

@@ -6,8 +6,8 @@ This is a project management repo for the Data Safe Havens in the Cloud team at
 
 - [Useful links](#useful-links)
 - [New starters checklist](#new-starters-checklist)
-    - [First steps](#first-steps-for-all-starters)
-    - [Developer steps](#next-steps-for-developers)
+  - [First steps](#first-steps-for-all-starters)
+  - [Developer steps](#next-steps-for-developers)
 - [Contacts](#contacts)
 - [Releases](#releases)
 
@@ -37,29 +37,28 @@ This is a project management repo for the Data Safe Havens in the Cloud team at
 - [SATRE spec doc repo](https://github.com/sa-tre/satre-specification) (public) repo used for hosting/writing the specification doc/ reference architecture (work package 1)
 - [SATRE backlog board](https://github.com/orgs/sa-tre/projects/1) (public) for managing issues from the above repos
 
-
 ## New starters checklist
 
 Welcome to the Data Safe Haven team! 🎉
 
 You should read this page and follow the instructions if you're joining the project for the first time at The Alan Turing Institute.
 
-### First steps for *all starters*
+### First steps for _all starters_
 
 1. **Bookmark** this page and the other [useful links](#useful-links) above
 2. **Read up:** On the [documentation site](https://data-safe-haven.readthedocs.io/en/develop/index.html), click the `Overview` tab, where you will find links to resources that explain what Data Safe Haven is and why someone would want to use it.
-    - In particular, it's worth studying the [diagram](https://figshare.com/articles/poster/Data_Safe_Havens_in_the_Cloud/11815224) which displays the overall architecture of DSH, including the distinction between the Safe Haven Management (SHM) and Secure Research Environments (SREs) and the data classification system.
+   - In particular, it's worth studying the [diagram](https://figshare.com/articles/poster/Data_Safe_Havens_in_the_Cloud/11815224) which displays the overall architecture of DSH, including the distinction between the Safe Haven Management (SHM) and Secure Research Environments (SREs) and the data classification system.
 3. **Access:** We have internal discussions about the project via Slack and manage our work via a combination of GitHub and Microsoft Sharepoint:
-    - **Slack:** Ensure you have access to the Alan Turing Institute Slack workspace and join the following channels: `#data-safe-haven` and `#data-safe-haven-team` (the latter is private and you may need to request a team member to add you, see [contacts](#contacts)).
-    - **Slack:** You can also join the external-facing Slack workspace called `Turing Data Safe Haven`, used for release announcements and other communications with the community of DSH users. Ask a team member to add you (see [contacts](#contacts)).
-    - **Sharepoint:** Internal documents are stored on [sharepoint](https://thealanturininstitute.sharepoint.com/sites/SafeHaven). You will need to have your Turing SSO set up. Ask a team member to add you to the group with access rights (see [contacts](#contacts)).
-    - **GitHub:** We use a GitHub [project board](https://github.com/orgs/alan-turing-institute/projects/40/views/1) to manage who is working on what. [Familiarise yourself](https://docs.github.com/en/github-ae@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) if you haven't used one before and check you can add issues to the `data-safe-haven-team` or `data-safe-haven` repos from the project board view.
+   - **Slack:** Ensure you have access to the Alan Turing Institute Slack workspace and join the following channels: `#data-safe-haven` and `#data-safe-haven-team` (the latter is private and you may need to request a team member to add you, see [contacts](#contacts)).
+   - **Slack:** You can also join the external-facing Slack workspace called `Turing Data Safe Haven`, used for release announcements and other communications with the community of DSH users. Ask a team member to add you (see [contacts](#contacts)).
+   - **Sharepoint:** Internal documents are stored on [sharepoint](https://thealanturininstitute.sharepoint.com/sites/SafeHaven). You will need to have your Turing SSO set up. Ask a team member to add you to the group with access rights (see [contacts](#contacts)).
+   - **GitHub:** We use a GitHub [project board](https://github.com/orgs/alan-turing-institute/projects/40/views/1) to manage who is working on what. [Familiarise yourself](https://docs.github.com/en/github-ae@latest/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) if you haven't used one before and check you can add issues to the `data-safe-haven-team` or `data-safe-haven` repos from the project board view.
 4. **Explore:** Ask one of the existing Data Safe Haven team (see [contacts](#contacts)) to create a non-privileged user account in the test SRE called `sandbox`, so you can log in explore it from a user perspective and familiarise yourself with how it works. This is available at https://sandbox.prod4.turingsafehaven.ac.uk/
 
-### Next steps for *developers*
+### Next steps for _developers_
 
 1. **Deploy:** The best way to familiarise yourself with the codebase is to have a go at deploying either an SRE to an existing SHM, or if time permits, a new SHM and attached SRE. Click on the `Deployment` tab in the [DSH documentation](https://data-safe-haven.readthedocs.io/en/develop/index.html) and follow the guides available there. Either choose the latest release docs or try `develop` if you're feeling adventurous!
-    - Note: When you're done with any test SHM/SREs, you should follow the "Tear down" instructions in the respective guides.
+   - Note: When you're done with any test SHM/SREs, you should follow the "Tear down" instructions in the respective guides.
 2. **Open issues:** If you notice any bugs in the Safe Haven code when deploying an SHM or SRE, open an issue [on the main repo](https://github.com/alan-turing-institute/data-safe-haven/issues). Take care to follow the issue template.
 3. **Contribute code:** If you want to contribute changes to the code base, perhaps to fix an issue that you have identified during deployment, create a fork of the main repository on your personal Github account, modify the relevant code on your fork, and then create a [pull request](https://github.com/alan-turing-institute/data-safe-haven/pulls).
 

Reports/Monthly.md

@@ -1,4 +1,5 @@
 # Month by month report
+
 This should replace the current hackmd used in monthly meeting and contain the necessary structure to directly be used to build any reports
 
 To be updated via Monthly issue and associated PR

WaysofWork.md

@@ -53,7 +53,7 @@ The Ways of Work process should adhere to the following principles:
 ### Stories and other issues
 
 Some details on how issues and stories are linked together will vary after GH releases Tracked & Tracked By and Tasklist features,
-currently in [private beta]( https://docs.github.com/en/issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields)
+currently in [private beta](https://docs.github.com/en/issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields)
 
 #### Story issues
 

monthly-meeting-template.md

@@ -10,12 +10,12 @@ tags: dsh
 
 ## Schedule
 
-|   Time      |   Item   |
-|-------------|----------|
-| 0 - 10 mins  | Project update overview |
-| 10 - 15 mins | Last month actions status |
-| 15 - 50 | Agenda items and required actions |
-| 50 - 60 | Actions and delegation |
+| Time         | Item                              |
+| ------------ | --------------------------------- |
+| 0 - 10 mins  | Project update overview           |
+| 10 - 15 mins | Last month actions status         |
+| 15 - 50      | Agenda items and required actions |
+| 50 - 60      | Actions and delegation            |
 
 ## Attendees
 

weekly-standup-template.md

@@ -367,7 +367,7 @@ The actions here should not be used to assign work.
 -->
 
 | Owner             | Action                               |
-| -------           | --------                             |
+| ----------------- | ------------------------------------ |
 | Meeting organiser | Open meeting record for next meeting |
 | Meeting organiser | Save meeting record (sharepoint)     |
 | Project manager   | Produce digest for monthly meeting   |