@@ -10,40 +10,35 @@ Before committing code changes to Apache Pulsar Manager, you need to install req
10
10
11
11
If you have not installed Java and Node, follow the instructions below.
12
12
13
- Dependency | Installation guide
14
- |---| ---
15
- Java 8 | https://openjdk.java.net/install/
16
- Node 10.15 | https://nodejs.org/en/
13
+ | Dependency | Installation guide |
14
+ | ---------- | --------------------------------- |
15
+ | Java 8 | https://openjdk.java.net/install/ |
16
+ | Node 10.15 | https://nodejs.org/en/ |
17
17
18
18
### Fork pulsar-manager repository
19
19
20
20
Fork the [ pulsar-manager] ( https://github.com/apache/pulsar-manager ) repository to your GitHub repository.
21
21
22
- ### Install pulsar-manager dependency
22
+ ### Install pulsar-manager dependency
23
23
24
24
1 . Clone pulsar-manager code to your machine.
25
-
25
+
26
26
``` bash
27
- $ git clone git@github.com:[your-github-id]/pulsar-manager.git
27
+ git clone git@github.com:[your-github-id]/pulsar-manager.git
28
28
```
29
29
30
30
2. Install pulsar-manger dependencies.
31
-
32
- ` ` ` bash
33
- $ cd pulsar-manager
34
-
35
- $ ./gradlew build -x test
36
31
37
- $ cd front-end
38
-
39
- $ npm install --save
32
+ ` ` ` bash
33
+ cd pulsar-manager
34
+ ./gradlew build -x test
40
35
` ` `
41
36
42
- # # Configure IDE
37
+ # # Configure IDE
43
38
44
39
Apache Pulsar Manager uses [lombok](https://projectlombok.org/), so set up your IDE with the required plugins.
45
40
46
- # ## Configure Intellij
41
+ # ## Configure Intellij
47
42
48
43
To configure annotation processing in IntelliJ, follow the steps below.
49
44
@@ -60,35 +55,32 @@ Follow the instructions [here](https://howtodoinjava.com/automation/lombok-eclip
60
55
# # Contribution workflow
61
56
62
57
1. Add a remote repository.
63
-
58
+
64
59
` ` ` bash
65
- $ git remote add apache git@github.com:apache/pulsar-manager.git
60
+ git remote add apache git@github.com:apache/pulsar-manager.git
66
61
` ` `
67
62
68
63
2. Sync you local repository with the remote repository.
69
64
70
65
` ` ` bash
71
- $ git checkout master
72
- $ git pull apache master
66
+ git checkout master
67
+ git pull apache master
73
68
` ` `
74
69
75
70
3. Create your PR and commit code changes.
76
71
77
72
` ` ` bash
78
- $ git checkout -b your_branch
79
-
80
- $ git add [your change files]
81
-
82
- $ git commit -m " commit messages"
83
-
84
- $ git push origin your_branch
73
+ git checkout -b your_branch
74
+ git add [your change files]
75
+ git commit -m " commit messages"
76
+ git push origin your_branch
85
77
` ` `
86
78
87
- > # ### Note
88
- >
89
- > Apache Pulsar Manager uses the open-source protocol of Apache License 2.0.
79
+ > ** Note**
80
+ >
81
+ > Pulsar Manager is released under Apache License 2.0.
90
82
>
91
- > If you commit code changes with new files, run the following command to add the license at the beginning of each file.
83
+ > If you commit new files, run the following command to add the license header for each file:
92
84
>
93
85
> ` ` ` bash
94
86
> ./gradlew licenseFormat
@@ -100,8 +92,8 @@ Follow the code styles below to keep code consistent and easy to maintain.
100
92
101
93
Make sure your code looks plain and simple.
102
94
103
- Language | Code style guide
104
- | ---| ---
105
- Java | https://google.github.io/styleguide/javaguide.html
106
- Vue | https://vuejs.org/v2/style-guide/
95
+ | Language | Code style guide |
96
+ | -------- | -------------------------------------------------- |
97
+ | Java | https://google.github.io/styleguide/javaguide.html |
98
+ | Vue | https://vuejs.org/v2/style-guide/ |
107
99
0 commit comments