Skip to content

Commit

Permalink
Merge pull request #121 from DTS-STN/lharrison-templates-and-readme
Browse files Browse the repository at this point in the history
Updating Readme, PR and Issue Templates
  • Loading branch information
lhr-git authored Jul 28, 2023
2 parents 7b28963 + 33a1abd commit cb22ad0
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 14 deletions.
16 changes: 6 additions & 10 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"
19 changes: 15 additions & 4 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -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:
9 changes: 9 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

-
Expand Down

0 comments on commit cb22ad0

Please sign in to comment.