Skip to content

Commit

Permalink
readd .github files
Browse files Browse the repository at this point in the history
  • Loading branch information
ickynavigator committed Jul 27, 2024
1 parent 65a04ce commit 59d7d18
Show file tree
Hide file tree
Showing 3 changed files with 128 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Feature
description: An enhancement or feature
title: "[Feature]: "
labels: ["triage", "feature"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A step-by-step description of the suggested feature/enhancement.
placeholder: On the user page, you should be able to...
validations:
required: true
- type: textarea
id: acceptanceCriteria
attributes:
label: Acceptance Criteria
description: What are the things that must be achieved for your ticket to be considered complete.
validations:
required: true
- type: markdown
attributes:
value: >
| Please include any screenshots which would help demonstrate the steps
and point out which parts the feature is related to
- type: textarea
id: links
attributes:
label: Links
description: Place links to supporting docs here. e.g. Figma
value: >
| [`FIGMA LINK`](LINK_HERE)
- type: textarea
id: images
attributes:
label: Images
description: Paste images or image urls
value: "![image](URL_HERE)"
49 changes: 49 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!-- Do not delete this PR template. Just edit it to include the required information -->

# Description

<!-- If your PR fixes an open issue, use `Closes #999` to link your PR with the issue. #999 stands for the issue number you are fixing -->

<!-- Github Issue Example: Closes #31 -->

**Closes #issue_number_here**

# Changes proposed

## What were you told to do?

<!-- Write the title of the issue/feature you are working on -->

## What did you do?

<!-- Talk about the things you did eg. files changes, dependencies installed e.t.c -->

# Check List (Check all the applicable boxes)

🚨Please review the [contribution guideline](CONTRIBUTING.md) for this repository.

<!-- Mark all the applicable boxes. To mark the box as done follow the following conventions -->

<!--
[x] - Correct; marked as done
[X] - Correct; marked as done
[ ] - Correct; marked as **not** done
[] - Not Correct; syntax error
[ x] - Not Correct; space between the brackets
-->

- [ ] My code follows the code style of this project.
- [ ] This PR does not contain plagiarized content.
- [ ] The title and description of the PR is clear and explains the approach.
- [ ] I am making a pull request against the **dev branch** (left side).
- [ ] My commit messages styles matches our requested structure.
- [ ] My code additions will fail neither code linting checks nor unit test.
- [ ] I am only making changes to files I was requested to.

# Screenshots/Videos

<!-- If the changes are static page changes or UI changes add screenshots -->
<!-- If the changes involve implementing a functionality or working with apis, include a video
detailing how to implement the functionality and the request to the api and responses from the api endpoint-->
<!-- Add all the screenshots/videos which support your changes i.e before your change and after your change -->
41 changes: 41 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Checks

on:
push:
branches:
- main
- dev
- staging

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
- uses: pnpm/action-setup@v4
with:
version: 9
- run: pnpm install
- name: "Test"
run: pnpm run test:ci

eslint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
- uses: pnpm/action-setup@v4
with:
version: 9
- run: pnpm install
- uses: reviewdog/action-eslint@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
fail_on_error: true
reporter: github-pr-check
eslint_flags: ". --ext js,jsx,ts,tsx --ignore-path=.gitignore --max-warnings 0"

0 comments on commit 59d7d18

Please sign in to comment.