Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format markdown with spotless #267

Merged
merged 1 commit into from
Feb 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/type_bug.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---

name: Bug report
about: Create a report to help us improve
title: ''
Expand Down Expand Up @@ -26,8 +27,7 @@ If possible add the full stacktrace or Zeebe log which contains the issue.
</pre>
</details>


**Environment:**
- OS: [e.g. Linux]
- Docker version: [e.g. 19.03.5]
- Zeebe Test Container version: [e.g. 0.22.1]
- OS: [e.g. Linux]
- Docker version: [e.g. 19.03.5]
- Zeebe Test Container version: [e.g. 0.22.1]
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/type_docs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---

name: Documentation issue
about: Improvements, additions, or modifications of the documentation
title: ''
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/type_feature.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---

name: Feature request
about: Request user facing changes, e.g. API changes
title: ''
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/type_maintenance.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---

name: General issue
about: General, non-user facing changes, e.g. refactoring, clean ups, etc.
title: ''
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/type_project.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---

name: Project management issue
about: Changes or improvements to the project, e.g. bot configurations, code style, etc.
title: ''
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/type_test.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---

name: Test issue
about: Improvements or changes to the existing tests
title: ''
Expand Down
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ closes #
- [ ] The submitting code follows our [code style](https://github.com/camunda-cloud/zeebe/wiki/Code-Style)
- [ ] If submitting code, please run `mvn clean install -DskipTests` locally before committing
- [ ] Ensure all PR checks are green

26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,10 +269,10 @@ The container is considered started if and only if:
about the
ports [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/network-ports/))
.
1. The broker ready check returns a 204 (see more about this
2. The broker ready check returns a 204 (see more about this
check [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/health/#ready-check))
.
1. The gateway topology is considered complete.
3. The gateway topology is considered complete.

> A topology is considered complete if there is a leader for all partitions.

Expand All @@ -291,7 +291,7 @@ The container is considered started if and only if:
the
ports [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/network-ports/))
.
1. The broker ready check returns a 204 (see more about this
2. The broker ready check returns a 204 (see more about this
check [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/health/#ready-check))
.

Expand All @@ -311,7 +311,7 @@ The container is considered started if and only if:
1. The cluster and gateway ports are open and accepting connections (read more about the
ports [here](https://docs.camunda.io/docs/components/zeebe/deployment-guide/operations/network-ports/))
.
1. The gateway topology is considered complete.
2. The gateway topology is considered complete.

> A topology is considered complete if there is a leader for all partitions.

Expand All @@ -328,7 +328,7 @@ variables or via configuration file. You can find out more about it on the
> Zeebe 0.23.x and upwards use Spring Boot for configuration - refer to their documentation on how
> environment variables are mapped to configuration settings. You can read more about this
> [here](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config)

>
> Testcontainers provide mechanisms through which
> [environment variables can be injected](https://www.javadoc.io/doc/org.testcontainers/testcontainers/1.14.3/org/testcontainers/containers/GenericContainer.html#withEnv-java.lang.String-java.lang.String-),
> or [configuration files mounted](https://www.testcontainers.org/features/files/). Refer to their
Expand Down Expand Up @@ -1004,26 +1004,28 @@ To work on an issue, follow the following steps:

1. Check that a [GitHub issue][issues] exists for the task you want to work on. If one does not,
create one.
1. Checkout the `master` branch and pull the latest changes.
2. Checkout the `master` branch and pull the latest changes.

```
git checkout develop
git pull
```
1. Create a new branch with the naming scheme `issueId-description`.
3. Create a new branch with the naming scheme `issueId-description`.

```
git checkout -b 123-my-new-feature
```
1. Follow
4. Follow
the [Google Java Format](https://github.com/google/google-java-format#intellij-android-studio-and-other-jetbrains-ides)
and [Zeebe Code Style](https://github.com/zeebe-io/zeebe/wiki/Code-Style) while coding.
1. Implement the required changes on your branch, and make sure to build and test your changes
5. Implement the required changes on your branch, and make sure to build and test your changes
locally before opening a pull requests for review.
1. If you want to make use of the CI facilities before your feature is ready for review, feel free
6. If you want to make use of the CI facilities before your feature is ready for review, feel free
to open a draft PR.
1. If you think you finished the issue please prepare the branch for reviewing. In general the
7. If you think you finished the issue please prepare the branch for reviewing. In general the
commits should be squashed into meaningful commits with a helpful message. This means cleanup/fix
etc commits should be squashed into the related commit.
1. Finally, be sure to check on the CI results and fix any reported errors.
8. Finally, be sure to check on the CI results and fix any reported errors.

## Commit Message Guidelines

Expand Down
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

These are the versions currently maintained and supported. If you detect any security vulnerabilities for any of these, please report them as described below.

| Version | Supported |
| ------- | ------------------ |
| Version | Supported |
|---------|--------------------|
| 3.x.x | :white_check_mark: |
| 2.x.x | :x: |
| 1.x.x | :x: |
Expand Down
7 changes: 7 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,13 @@
<expandEmptyElements>false</expandEmptyElements>
</sortPom>
</pom>
<markdown>
<includes>
<include>**/*.md</include>
</includes>

<flexmark/>
</markdown>
</configuration>
<executions>
<execution>
Expand Down