Skip to content

Commit

Permalink
Fix typos in top-level documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
marcwrobel committed Jun 17, 2022
1 parent ce94ae6 commit 094edcb
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions COMMITTERS.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The first thing is that, while being a committer,
you can't really commit directly to the main repository:
you need at least one review by your peers.

Thus the need for a pull request.
Thus, the need for a pull request.

So you are more like a merger than a committer
and you might merge more PRs from others than your own work.
Expand All @@ -38,7 +38,7 @@ While not absolute, here is some advice:
If the PR is very large or is a new extension, better let it
bake for a few days.
* We do _merge commits_ so please ask the author to properly squash the commits before merging (when it makes sense).
The idea is to have proper semantic commits. Several commits is not a problem as long as they have a proper semantic.
The idea is to have proper semantic commits. Several commits are not a problem as long as they have a proper semantic.
If the author is not familiar with Git or not available, you can also (carefully)
https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork[do it for them]
as long as you both agreed on it.
Expand Down Expand Up @@ -105,7 +105,7 @@ And, in any case, we should avoid upgrading these dependencies after the CR1 whe
[[backward-compatibility]]
== Backward Compatibility

Quarkus evolves very fast and we decided we could break backward compatibility as long as:
Quarkus evolves very fast, and we decided we could break backward compatibility as long as:

* It is worth it.
* We try to support the previous behavior for a while - if it doesn't have a prohibitive cost,
Expand Down Expand Up @@ -134,7 +134,7 @@ If your commit message was too long and GitHub automatically cut
the title, it is helpful if you can take the time to move the cut
part where it belongs to have a full title.

Titles are included in the Release notes so they are important.
Titles are included in the Release notes, so they are important.

A good title would look like: `Fix off by one issue in Quartz extension` or
`Introduce Hibernate Reactive extension`.
Expand Down Expand Up @@ -199,7 +199,7 @@ release a couple of weeks after.
Every time we do a major release (e.g. `2.7.0.Final`), we create a release branch (e.g. `2.7`) to host
the commits for these bugfix releases.

All the pull requests are merged in the `main` branch so they are applied to the new feature
All the pull requests are merged in the `main` branch, so they are applied to the new feature
release of Quarkus.
They won't be integrated in the previous version branch.

Expand Down Expand Up @@ -242,5 +242,5 @@ Obviously, critical bugs are not good candidates :).

Take a deep breath and don't worry, it happens.

Just ping `@quarkusio/committerhelp` on GitHub or `@committerhelp` on Zulip
Just ping `@quarkusio/committerhelp` on GitHub or `@committerhelp` on Zulip,
and we will find a solution.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ Here are a few recommendation guidelines:
- describe the function over the technology
- use an action / verb to start the sentence
- do not conjugate the action verb (`Connect foo`, not `Connects foo` nor `Connecting foo`)
- connectors (JDBC / reactive) etc tend to start with Connect
- connectors (JDBC / reactive) etc. tend to start with Connect
- do not mention `Quarkus`
- do not mention `extension`
- avoid repeating the extension name
Expand Down
2 changes: 1 addition & 1 deletion MAINTAINERS.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Below is the list of maintainers for each Quarkus extension hosted in the main repository.

If you think some information is outdated, either provide a pull request or send an email to the `quarkus-dev` mailing list.
If you think some information is outdated, either provide a pull request or email the `quarkus-dev` mailing list.

[cols=2*,options="header"]
|===
Expand Down
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Please report any security issues you find in Quarkus to:

security at quarkus.io

Anyone can post to this list. The subscribers are only trusted individuals from the Quarkus community who will handle the resolution of any reported security issues in confidence. In your report, please note how you would like to be credited for discovering the issue and the details of any embargo you would like to impose. Currently the security response teams for the following distributions are subscribed to this list and will respond to your report:
Anyone can post to this list. The subscribers are only trusted individuals from the Quarkus community who will handle the resolution of any reported security issues in confidence. In your report, please note how you would like to be credited for discovering the issue and the details of any embargo you would like to impose. Currently, the security response teams for the following distributions are subscribed to this list and will respond to your report:

* [Red Hat](https://access.redhat.com/security/team/contact/)

Expand Down Expand Up @@ -42,4 +42,4 @@ We may fix the vulnerability to older versions depending on the severity of the

## Handling security issues

If you represent a Quarkus extension or a Quarkus platform, you are welcome to subscribe to the security at quarkus.io mailing list. Your subscription will only be approved if you can demonstrate that you will handle issues in confidence and properly credit reporters for discovering issues (e.g. experience with embargoe process).
If you represent a Quarkus extension or a Quarkus platform, you are welcome to subscribe to the security at quarkus.io mailing list. Your subscription will only be approved if you can demonstrate that you will handle issues in confidence and properly credit reporters for discovering issues (e.g. experience with embargo process).
4 changes: 2 additions & 2 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Performance is at the heart of Quarkus.

If you are facing performance issues (runtime or startup issues), and would like to discuss them with the Quarkus Team,
you are more than welcome on our [mailing list](https://groups.google.com/d/forum/quarkus-dev),
[Zulip chat](https://quarkusio.zulipchat.com) or [Github issue tracker](https://github.com/quarkusio/quarkus/issues).
[Zulip chat](https://quarkusio.zulipchat.com) or [GitHub issue tracker](https://github.com/quarkusio/quarkus/issues).

To help us troubleshoot your issues, we will need some performance insights from your application.

Expand Down Expand Up @@ -77,7 +77,7 @@ To start CPU profiling, execute the following command:

`-b 4000000` is used to increase the frame buffer size as the default is often too small.

To end profiling and gather the results you can launch the same command with the `stop` subcommand, this will tells you if the buffer frame was too small.
To end profiling and gather the results you can launch the same command with the `stop` subcommand, this will tell you if the buffer frame was too small.
The output is a text file that is not really usable, so let's use our preferred performance representation: the flame graph.

```shell script
Expand Down

0 comments on commit 094edcb

Please sign in to comment.