This commit is contained in:
Adil Arain 2025-05-27 13:38:02 +00:00 committed by GitHub
commit 2c200b788a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 56 additions and 3 deletions

20
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,20 @@
## 📋 Description
Please include a summary of the changes and the related issue.
## 🧾 Related Issue
Closes #<issue-number>
## 🖼️ Screenshots (if applicable)
- Before:
- After:
## ✅ Checklist
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation (if any)
- [ ] My changes generate no new warnings

31
.github/workflows/ci.yml vendored Normal file
View File

@ -0,0 +1,31 @@
name: CI - Build and Test
on:
pull_request:
branches: [main]
push:
branches: [main]
jobs:
build:
name: Run Build and Tests
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: "18"
cache: "npm"
- name: Install Dependencies
run: npm ci
- name: Run Linter
run: npm run lint
- name: Run Unit Tests
run: npm test

View File

@ -6,9 +6,7 @@ There are various ways in which you can contribute to this project such as `upda
When making any critical change to this repository, please first discuss the change you wish to make via issue, email, or any other method with the [owners](https://github.com/volcano-sh/dashboard/blob/main/OWNERS) of this repository before making a change.
## Getting Started
Make sure [`node.js`](https://nodejs.org/en/download) is installed on your system and we prefer [`visual-studio-code`](https://code.visualstudio.com/download) as IDE.
🚀 For dashboard setup, see the [Getting Started](./README.md#getting-started) section in README.
### Prerequisites

View File

@ -10,6 +10,10 @@ The volcano dashboard provides a basic dashboard that can be easily deployed in
You can follow the [design doc](docs/design.md) to learn more about the design details.
## Getting Started
Make sure [`node.js`](https://nodejs.org/en/download) is installed on your system and we prefer [`visual-studio-code`](https://code.visualstudio.com/download) as IDE. Thanks.
## Contributing
You can follow our [CONTRIBUTING.md](CONTRIBUTING.md).