You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Volcano follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
4
+
5
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at <cncf-volcano-maintainers@lists.cncf.io>.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+25-16Lines changed: 25 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,33 +6,35 @@ There are various ways in which you can contribute to this project such as `upda
6
6
7
7
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.
8
8
9
-
## Getting Started
10
-
11
-
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.
9
+
## Before You Get Started
12
10
13
11
### Prerequisites
14
12
15
-
Please follow the [guide](https://github.com/volcano-sh/volcano#quick-start-guide) to install volcano first.
13
+
To contribute to the volcano dashboard project, you need:
16
14
17
-
### Install volcano dashboard
15
+
-[`node.js`](https://nodejs.org/en/download) installed on your system
16
+
- A running Kubernetes cluster with [Volcano](https://github.com/volcano-sh/volcano#quick-start-guide) installed
17
+
- Volcano dashboard deployed (see [Installation Guide](README.md#installation) in the main README)
18
18
19
-
Login one node of your kubernetes cluster and execute the following command to install volcano dashboard.
19
+
## Your First Contribution
20
20
21
-
```bash
22
-
kubectl create ns volcano-system
21
+
We are always in need of help, be it fixing documentation, reporting bugs, or writing code. Look at places where you feel best coding practices aren't followed, code refactoring is needed, or tests are missing.
Then use the following command to map the traffic to node.
25
+
Check out the [issues](https://github.com/volcano-sh/dashboard/issues) in this repository. Issues labeled [good first issue](https://github.com/volcano-sh/dashboard/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) are great starting points for new contributors.
Access the dashboard by navigate to `http://$YOUR_NODE_IP:8080` in your browser.
29
+
When you are willing to take on an issue, you can assign it to yourself. Just reply with `/assign` or `/assign @yourself` on an issue, and the robot will assign the issue to you.
34
30
35
-
If running locally navigate to `http://localhost:8080`
31
+
### File an Issue
32
+
33
+
While we encourage everyone to contribute code, it is also appreciated when someone reports an issue.
34
+
35
+
Please follow the prompted submission guidelines while opening an issue.
36
+
37
+
## Contributor Workflow
36
38
37
39
### Development
38
40
@@ -139,3 +141,10 @@ git commit --amend -s
139
141
```bash
140
142
git push origin <your-branch>
141
143
```
144
+
145
+
4. Create a pull request
146
+
147
+
Submit a pull request to the [volcano-sh/dashboard](https://github.com/volcano-sh/dashboard) repository. The PR should:
0 commit comments