summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2022-12-08 15:13:13 +0300
committerPatrick Williams <patrick@stwcx.xyz>2022-12-08 15:13:13 +0300
commit7385e139b0c9efca7430458cee982e63e282f4ae (patch)
tree1bbdb0164e556b76eec72cb558c66974c8f95dd8 /.github
parentb24a483eda5ca0b0ecdb4f0c61b90d76d0d8e1e0 (diff)
downloadwebui-vue-7385e139b0c9efca7430458cee982e63e282f4ae.tar.xz
prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML files to have consistent formatting for these file types. Re-run the formatter on the whole repository. Change-Id: I2804ee3ab5ff6bcbf986b028db2fafec8e616779 Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md40
-rw-r--r--.github/ISSUE_TEMPLATE/design-review.md24
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md23
-rw-r--r--.github/workflows/deploy-docs-to-gh-pages.yml54
4 files changed, 70 insertions, 71 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index dd84ea78..8457aa9f 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,38 +1,36 @@
---
name: Bug report
about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
---
-**Describe the bug**
-A clear and concise description of what the bug is.
+**Describe the bug** A clear and concise description of what the bug is.
+
+**To Reproduce** Steps to reproduce the behavior:
-**To Reproduce**
-Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+**Expected behavior** A clear and concise description of what you expected to
+happen.
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots** If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-**Additional context**
-Add any other context about the problem here.
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context** Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/design-review.md b/.github/ISSUE_TEMPLATE/design-review.md
index c00d2dff..9ab5001b 100644
--- a/.github/ISSUE_TEMPLATE/design-review.md
+++ b/.github/ISSUE_TEMPLATE/design-review.md
@@ -1,27 +1,29 @@
---
name: Design review
about: Create story used to track design proposals and decisions
-title: ''
+title: ""
labels: enhancement
-assignees: ''
-
+assignees: ""
---
## Use Case
-As a _______ user,
-I need to be able to _______
-so that I can _______.
+
+As a **\_\_\_** user, I need to be able to **\_\_\_** so that I can **\_\_\_**.
## Invision Prototype Guidance
-The Invision prototypes have hot spots allowing the reviewer to step through the workflow. To navigate a prototype, you can:
+
+The Invision prototypes have hot spots allowing the reviewer to step through the
+workflow. To navigate a prototype, you can:
1. Click on the page and the hotspots will be revealed in blue
1. Use the arrow-right and arrow-left keys on your keyboard
## Design Review Workflow
+
1. Each design iteration will have a comment section
1. The section will include:
- - A title with the iteration number
- - Any description or specific feedback the designer is requesting
- - Screenshots of the workflow
-1. Based on community and user feedback, we create a comment for the new iteration and repeat these steps
+ - A title with the iteration number
+ - Any description or specific feedback the designer is requesting
+ - Screenshots of the workflow
+1. Based on community and user feedback, we create a comment for the new
+ iteration and repeat these steps
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index bbcbbe7d..7c871938 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,20 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
---
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Is your feature request related to a problem? Please describe.** A clear and
+concise description of what the problem is. Ex. I'm always frustrated when [...]
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Describe the solution you'd like** A clear and concise description of what you
+want to happen.
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Describe alternatives you've considered** A clear and concise description of
+any alternative solutions or features you've considered.
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**Additional context** Add any other context or screenshots about the feature
+request here.
diff --git a/.github/workflows/deploy-docs-to-gh-pages.yml b/.github/workflows/deploy-docs-to-gh-pages.yml
index bbc39dde..fb8022fa 100644
--- a/.github/workflows/deploy-docs-to-gh-pages.yml
+++ b/.github/workflows/deploy-docs-to-gh-pages.yml
@@ -1,34 +1,34 @@
name: Deploy documentation to GitHub pages
on:
- push:
- branches: [ master ]
+ push:
+ branches: [master]
jobs:
- build:
- runs-on: ubuntu-latest
+ build:
+ runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v2
+ steps:
+ - uses: actions/checkout@v2
- - name: Generate static vuepress files
- uses: actions/setup-node@v1
- with:
- node-version: '12.x'
- - run: npm ci
- - run: npm run docs:build
+ - name: Generate static vuepress files
+ uses: actions/setup-node@v1
+ with:
+ node-version: "12.x"
+ - run: npm ci
+ - run: npm run docs:build
- - name: Init new repo in dist folder and commit generated files
- run: |
- cd docs/.vuepress/dist
- git init
- git add -A
- git config --local user.email "action@github.com"
- git config --local user.name "GitHub Action"
- git commit -m 'deploy'
+ - name: Init new repo in dist folder and commit generated files
+ run: |
+ cd docs/.vuepress/dist
+ git init
+ git add -A
+ git config --local user.email "action@github.com"
+ git config --local user.name "GitHub Action"
+ git commit -m 'deploy'
- - name: Force push to gh-pages branch
- uses: ad-m/github-push-action@v0.5.0
- with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- branch: gh-pages
- force: true
- directory: ./docs/.vuepress/dist
+ - name: Force push to gh-pages branch
+ uses: ad-m/github-push-action@v0.5.0
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ branch: gh-pages
+ force: true
+ directory: ./docs/.vuepress/dist