-
Notifications
You must be signed in to change notification settings - Fork 248
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: tison <[email protected]>
- Loading branch information
Showing
4 changed files
with
35 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,40 +10,35 @@ Before committing code changes to Apache Pulsar Manager, you need to install req | |
|
||
If you have not installed Java and Node, follow the instructions below. | ||
|
||
Dependency | Installation guide | ||
|---|--- | ||
Java 8 | https://openjdk.java.net/install/ | ||
Node 10.15 | https://nodejs.org/en/ | ||
| Dependency | Installation guide | | ||
| ---------- | --------------------------------- | | ||
| Java 8 | https://openjdk.java.net/install/ | | ||
| Node 10.15 | https://nodejs.org/en/ | | ||
|
||
### Fork pulsar-manager repository | ||
|
||
Fork the [pulsar-manager](https://github.com/apache/pulsar-manager) repository to your GitHub repository. | ||
|
||
### Install pulsar-manager dependency | ||
### Install pulsar-manager dependency | ||
|
||
1. Clone pulsar-manager code to your machine. | ||
|
||
```bash | ||
$ git clone [email protected]:[your-github-id]/pulsar-manager.git | ||
git clone [email protected]:[your-github-id]/pulsar-manager.git | ||
``` | ||
|
||
2. Install pulsar-manger dependencies. | ||
|
||
```bash | ||
$ cd pulsar-manager | ||
$ ./gradlew build -x test | ||
|
||
$ cd front-end | ||
$ npm install --save | ||
```bash | ||
cd pulsar-manager | ||
./gradlew build -x test | ||
``` | ||
|
||
## Configure IDE | ||
## Configure IDE | ||
|
||
Apache Pulsar Manager uses [lombok](https://projectlombok.org/), so set up your IDE with the required plugins. | ||
|
||
### Configure Intellij | ||
### Configure Intellij | ||
|
||
To configure annotation processing in IntelliJ, follow the steps below. | ||
|
||
|
@@ -60,35 +55,32 @@ Follow the instructions [here](https://howtodoinjava.com/automation/lombok-eclip | |
## Contribution workflow | ||
|
||
1. Add a remote repository. | ||
|
||
```bash | ||
$ git remote add apache [email protected]:apache/pulsar-manager.git | ||
git remote add apache [email protected]:apache/pulsar-manager.git | ||
``` | ||
|
||
2. Sync you local repository with the remote repository. | ||
|
||
```bash | ||
$ git checkout master | ||
$ git pull apache master | ||
git checkout master | ||
git pull apache master | ||
``` | ||
|
||
3. Create your PR and commit code changes. | ||
|
||
```bash | ||
$ git checkout -b your_branch | ||
$ git add [your change files] | ||
$ git commit -m "commit messages" | ||
$ git push origin your_branch | ||
git checkout -b your_branch | ||
git add [your change files] | ||
git commit -m "commit messages" | ||
git push origin your_branch | ||
``` | ||
|
||
> #### Note | ||
> | ||
> Apache Pulsar Manager uses the open-source protocol of Apache License 2.0. | ||
> **Note** | ||
> | ||
> Pulsar Manager is released under Apache License 2.0. | ||
> | ||
> If you commit code changes with new files, run the following command to add the license at the beginning of each file. | ||
> If you commit new files, run the following command to add the license header for each file: | ||
> | ||
> ```bash | ||
> ./gradlew licenseFormat | ||
|
@@ -100,8 +92,8 @@ Follow the code styles below to keep code consistent and easy to maintain. | |
|
||
Make sure your code looks plain and simple. | ||
|
||
Language | Code style guide | ||
|---|--- | ||
Java | https://google.github.io/styleguide/javaguide.html | ||
Vue | https://vuejs.org/v2/style-guide/ | ||
| Language | Code style guide | | ||
| -------- | -------------------------------------------------- | | ||
| Java | https://google.github.io/styleguide/javaguide.html | | ||
| Vue | https://vuejs.org/v2/style-guide/ | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters