Updating Readme, PR and Issue Templates

DTS-STN · Jul 27, 2023 · 33a1abd · 33a1abd
1 parent 7b28963
commit 33a1abd
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 14 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -39,6 +39,12 @@ First, create/copy the env file.
 cp .env.example .env
 ```
 
+Second, install npm packages:
+
+```bash
+npm i
+```
+
 Then, run the development server:
 
 ```bash
@@ -48,13 +54,3 @@ yarn dev
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
-
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
-
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
-
-## PR Procedures/Definition of done
-
-Have at least one person reviewing each PR before it can be merged. Each branch should be prefixed with the ID of the relevant ADO task. Eg. "379-update-readme"
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -1,7 +1,18 @@
-## [DC-XXX](https://jira-dev.bdm-dev.dts-stn.com/browse/DC-XXX) (JIRA issue, if applicable)
+## I'm submitting a ...
 
-### Description
+- [ ] bug report
+- [ ] feature request
 
-### Success Criteria
+## What is the current behavior?
 
-### Addtional Notes
+## If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
+
+## What is the expected behavior?
+
+## What is the motivation / use case for changing the behavior?
+
+## Please tell us about your environment:
+
+Version:
+Browser:
+Language:
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -2,6 +2,15 @@
 
 ### Description
 
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
 List of proposed changes:
 
 -