Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ This repository contains the web application code for the NIH-funded Brain Behav

## Development

- Please refer to the [frontend][frontend/] README.md
- Please refer to the [frontend](frontend/) README.md

## Contributing

Contibutions are welcome through pull requests- please notify the BBQS EMBER team for review.
Contibutions are welcome through pull requests. Please notify the BBQS EMBER team for review.
39 changes: 21 additions & 18 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ A Vue.js 3 / Quasar Project

1. Install dependencies

```bash
yarn install
```
```bash
yarn install
```

## Development

Expand All @@ -38,24 +38,27 @@ yarn install

## Testing

Our repository includes automated testing and formatting checks using GitLab CI/CD. The following is a list of tests that are run in the pipeline:
### Continuous Integration (CI) for Frontend

- Frontend Linting
This repository uses a **GitHub Actions** workflow to ensure code quality by running **ESLint** and **Prettier** checks.

- Job: lint-test-frontend
- Description: Checks that frontend code follows linting rules using ESLint.
- Steps to Run:
The workflow is triggered **on every pull request** and runs the following jobs:

```bash
yarn run lint
```
#### ESLint Check

- Frontend Formatting
- **Job**: `link-check`
- **Purpose**: Runs [ESLint](https://eslint.org/) to identify and enforce coding style and best practices.
- **Failure Resolution**:
- Run `yarn run lint` locally to see the errors.
- Fix the reported linting issues.
- This can either be done manually, or with `yarn run lint-fix`
- Commit and push the changes.

- Job: format-test-frontend
- Description: Checks that frontend code is formatted correctly using Prettier.
- Steps to Run:
#### Prettier Check

```bash
yarn run format
```
- **Job**: `format-check`
- **Purpose**: Runs [Prettier](https://prettier.io/) to check if the code follows the required formatting.
- **Failure Resolution**:
- Run `yarn run format-check` locally to see the errors.
- Run `yarn run format` locally to automatically fix formatting issues.
- Commit and push the changes.
1 change: 1 addition & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"private": true,
"scripts": {
"lint": "eslint --ext .js,.ts,.vue ./",
"lint-fix": "eslint --fix --ext .js,.ts,.vue ./",
"format": "prettier --write \"**/*.{js,ts,vue,scss,html,md,json}\" --ignore-path .gitignore",
"format-check": "prettier --check \"**/*.{js,ts,vue,scss,html,md,json}\" --ignore-path .gitignore",
"test": "echo \"No test specified\" && exit 0",
Expand Down