Skip to content

Commit 505b93a

Browse files
Add checkstyle info on CONTRIBUTING.md (#1290)
Signed-off-by: Matheus Cruz <[email protected]> Co-authored-by: artur-ciocanu <[email protected]>
1 parent bc2b04f commit 505b93a

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

CONTRIBUTING.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,25 @@ This section describes the guidelines for contributing code / docs to Dapr.
5656
All contributions come through pull requests. To submit a proposed change, we recommend following this workflow:
5757

5858
1. Make sure there's an issue (bug or proposal) raised, which sets the expectations for the contribution you are about to make.
59-
1. Fork the relevant repo and create a new branch
60-
1. Create your change
59+
2. Fork the relevant repo and create a new branch
60+
3. Create your change
6161
- Code changes require tests
62-
1. Update relevant documentation for the change
63-
1. Commit and open a PR
64-
1. Wait for the CI process to finish and make sure all checks are green
65-
1. A maintainer of the project will be assigned, and you can expect a review within a few days
62+
4. Update relevant documentation for the change
63+
5. Check the code style
64+
6. Commit and open a PR
65+
7. Wait for the CI process to finish and make sure all checks are green
66+
8. A maintainer of the project will be assigned, and you can expect a review within a few days
67+
68+
### Configure the code style with checkstyle
69+
70+
The project contains a checkstyle file (`checkstyle.xml`) that must be used for formatting the code.
71+
72+
* IntelliJ IDEA
73+
You can use [CheckStyle-IDEA plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea).
74+
* VSCode
75+
You can use [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle).
76+
* Eclipse
77+
You can use [Eclipse Checkstyle Plugin](https://checkstyle.org/eclipse-cs/#!/)
6678

6779
#### Use work-in-progress PRs for early feedback
6880

0 commit comments

Comments
 (0)