forked from apache/hertzbeat
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[improve]improve doc 052 (apache#2654)
- Loading branch information
1 parent
16cb8f6
commit 714f216
Showing
10 changed files
with
35 additions
and
35 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 |
|---|---|---|
|
|
@@ -64,7 +64,7 @@ The process works in the following way: | |
| 2. Clone the repository, and on it, copy the file `hip/TEMPLATE.md` and name it `hip-xxx.md`. The number `xxx` should be the next sequential number after the last contributed HIP. You view the list of contributed HIPs (at any status) as a list of Pull Requests having a "HIP" label. Use the link [here](https://github.com/apache/hertzbeat/pulls?q=is%3Apr+label%3Ahip+) as shortcut. | ||
| 3. Write the proposal following the section outlined by the template and the explanation for each section in the comment it contains (you can delete the comment once done). | ||
| * If you need diagrams, avoid attaching large files. You can use [MermaidJS](https://mermaid.js.org/) as simple language to describe many types of diagrams. | ||
| 4. Create GitHub Pull request (PR). The PR title should be `[improve][hip] HIP-xxx: {title}`, where the `xxx` match the number given in previous step (file-name). Replace `{title}` with a short title to your proposal. | ||
| 4. Create GitHub Pull request (PR). The PR title should be `[improve]\[HIP\] HIP-xxx: {title}`, where the `xxx` match the number given in previous step (file-name). Replace `{title}` with a short title to your proposal. | ||
| *Validate* again that your number does not collide, by step (2) numbering check. | ||
| 5. The author(s) will email the [email protected] mailing list to kick off a discussion, using subject prefix `[DISCUSS] HIP-xxx: {HIP TITLE}`. The discussion will happen in broader context either on the mailing list or as general comments on the PR. Many of the discussion items will be on particular aspect of the proposal, hence they should be as comments in the PR to specific lines in the proposal file. | ||
| 6. Update file with a link to the discussion on the mailing. You can obtain it from [Apache Pony Mail](https://lists.apache.org/[email protected]). | ||
|
|
@@ -86,7 +86,7 @@ It is advised to create a master GitHub issue to formulate the execution plan an | |
| ## List of HIPs | ||
|
|
||
| ### List of HIPs | ||
| 1. You can view all HIPs as the list of Pull Requests having title starting with `[improve][HIP] HIP-`. Here is the [link](https://github.com/apache/hertzbeat/pulls?q=is%3Apr+title%3A%22%5BHIP%5D%5Bdesign%5D+hip-%22) for it. | ||
| 1. You can view all HIPs as the list of Pull Requests having title starting with `[improve]\[HIP\] HIP-`. Here is the [link](https://github.com/apache/hertzbeat/pulls?q=is%3Apr+title%3A%22%5BHIP%5D%5Bdesign%5D+hip-%22) for it. | ||
| - Merged PR means the HIP was accepted. | ||
| - Closed PR means the HIP was rejected. | ||
| - Open PR means the HIP was submitted and is in the process of discussion. | ||
|
|
||
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
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 |
|---|---|---|
|
|
@@ -400,7 +400,7 @@ Thanks! | |
| After 72 hours, the voting results will be counted, and the voting result email will be sent, as follows. | ||
| > `Send to`: <[email protected]> <br /> | ||
| > `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br /> | ||
| > `Title`: [RESULT]\[VOTE\] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br /> | ||
| > `Body`: | ||
| ```text | ||
|
|
@@ -502,7 +502,7 @@ Chunjin Mu | |
| Then the voting results will be counted, and the voting result email will be sent, as follows. | ||
| > `Send to`: <[email protected]> <br /> | ||
| > `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br /> | ||
| > `Title`: [RESULT]\[VOTE\] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br /> | ||
| > `Body`: | ||
| ```text | ||
|
|
||
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
Oops, something went wrong.