Skip to content

Commit cf7605a

Browse files
authoredFeb 15, 2021
Update CONTRIBUTING.md
1 parent 61488e0 commit cf7605a

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed
 

‎CONTRIBUTING.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Develop
44

5-
#### 1. Fork it
5+
#### 1. Fork this repo
66

77
#### 2. Build the project
88

@@ -23,30 +23,28 @@ fix a bug, add a feature, update the doc, etc
2323
mvn test
2424
```
2525

26-
#### 5. Create a PR
26+
#### 5. Create a Pull Request (PR)
2727

28-
## Misc
28+
## Add yourself as a contributor
2929

30-
#### Add yourself as a contributor
31-
32-
After your PR has been merged, add yourself as a contributor.
33-
34-
To do so, add a comment like the following to your PR:
30+
Once your PR has been merged, add the following comment to your PR:
3531

3632
>@all-contributors please add @username for code and test!
3733
38-
_Replace code with doc or test or infra or some combination depending on your contribution._
34+
_Replace code and test with doc or test or infra or some combination depending on your contribution._
3935

40-
#### Package
36+
## Package
4137

42-
Contributors are not responsible for pushing packages to mavencentral and jcenter. Contributors are responsible for validating that the package step succeeds.
38+
Run the following to ensure the package step succeeds.
4339

4440
```shell
4541
mvn clean test jacoco:report package
4642
```
4743

4844
### Publish to Github Packages
4945

46+
_Note: This step can only be run by maintainers._
47+
5048
Add `distributionManagement` to `pom.xml`
5149

5250
```xml

0 commit comments

Comments
 (0)
Please sign in to comment.