Skip to content

Commit a77d38f

Browse files
authored
Fix CONTRIBUTING doc typo issues (#1266)
1 parent 18afc88 commit a77d38f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ issue, please bring it to their attention right away!
2121
Please **DO NOT** file a public issue, instead send your report privately to
2222
[xuri.me](https://xuri.me).
2323

24-
Security reports are greatly appreciated and we will publicly thank you for it.
24+
Security reports are greatly appreciated and we will publicly thank you for them.
2525
We currently do not offer a paid security bounty program, but are not
2626
ruling it out in the future.
2727

@@ -103,14 +103,14 @@ Before contributing large or high impact changes, make the effort to coordinate
103103
with the maintainers of the project before submitting a pull request. This
104104
prevents you from doing extra work that may or may not be merged.
105105

106-
Large PRs that are just submitted without any prior communication are unlikely
106+
Large PRs that are just submitted without any prior communication is unlikely
107107
to be successful.
108108

109109
While pull requests are the methodology for submitting changes to code, changes
110110
are much more likely to be accepted if they are accompanied by additional
111111
engineering work. While we don't define this explicitly, most of these goals
112-
are accomplished through communication of the design goals and subsequent
113-
solutions. Often times, it helps to first state the problem before presenting
112+
are accomplished through the communication of the design goals and subsequent
113+
solutions. Oftentimes, it helps to first state the problem before presenting
114114
solutions.
115115

116116
Typically, the best methods of accomplishing this are to submit an issue,
@@ -130,7 +130,7 @@ written in the imperative, followed by an optional, more detailed explanatory
130130
text which is separated from the summary by an empty line.
131131

132132
Commit messages should follow best practices, including explaining the context
133-
of the problem and how it was solved, including in caveats or follow up changes
133+
of the problem and how it was solved, including in caveats or follow-up changes
134134
required. They should tell the story of the change and provide readers
135135
understanding of what led to it.
136136

@@ -260,7 +260,7 @@ Don't forget: being a maintainer is a time investment. Make sure you
260260
will have time to make yourself available. You don't have to be a
261261
maintainer to make a difference on the project!
262262

263-
If you want to become a meintainer, contact [xuri.me](https://xuri.me) and given a introduction of you.
263+
If you want to become a maintainer, contact [xuri.me](https://xuri.me) and given an introduction of you.
264264

265265
## Community guidelines
266266

@@ -414,7 +414,7 @@ The first sentence should be a one-sentence summary that starts with the name be
414414

415415
It's helpful if everyone using the package can use the same name
416416
to refer to its contents, which implies that the package name should
417-
be good: short, concise, evocative. By convention, packages are
417+
be good: short, concise, and evocative. By convention, packages are
418418
given lower case, single-word names; there should be no need for
419419
underscores or mixedCaps. Err on the side of brevity, since everyone
420420
using your package will be typing that name. And don't worry about

0 commit comments

Comments
 (0)