Skip to content

Commit 0f4442d

Browse files
authored
Fix typos (#724)
Future note: We need to address the 2 comments, but not wanting the perfect to become the enemy of the good, I'm merging this now.
1 parent a37e63b commit 0f4442d

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

CONTRIBUTING-TO-ESAPI.txt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
Getting Started:
44
If you have not already done so, go back and read the section
55
"Contributing to ESAPI legacy" in ESAPI's README.md file. It
6-
make contain updates and advice not contained herein.
6+
may contain updates and advice not contained herein.
77

88
A Special Note on GitHub Authentication:
9-
GitHub has announced that they are deprecating authentiation based on
10-
username / password and beginning 2021-08-13, you will no longer be able
11-
to your password to authenticate to 'git' operations on GitHub.com.
9+
GitHub has announced that they are deprecating password based authentication
10+
using username / password and beginning 2021-08-13, you will no longer be
11+
able to your password to authenticate to 'git' operations on GitHub.com.
1212
Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/
1313
for details and plan accordingly.
1414

@@ -21,22 +21,23 @@ Finding Something Interesting to Work on:
2121
or "help wanted", those are good places to start for someone not yet
2222
familiar with the ESAPI code base.
2323

24-
You will need a account on GitHub though. Once you create one, let me know
24+
You will need a account on GitHub though. Once you create one, let us know
2525
what it is. Then if you want to work on a particular issue, we can assign
2626
it to you so someone else won't take it.
2727

28-
If you have questions, email Kevin Wall ([email protected]) or Matt Seil ([email protected]).
28+
If you have questions, email Kevin Wall ([email protected]) or Matt
29+
2930

3031
Overview:
3132
We are following the branching model described in
3233
https://nvie.com/posts/a-successful-git-branching-model
33-
If you are unfamiliar with it, you would be advised to give it a
34-
quick perusal. The major point is that the 'main' (formerly 'master') branch
35-
is reserved for official releases (which will be tagged), the 'develop' branch is
36-
used for ongoing development work and is the default branch, and we generally work
37-
off 'issue' branches named 'issue-#' where # is the GitHub issue number.
38-
(The last is not an absolute requirement, but rather a suggested
39-
approach.)
34+
If you are unfamiliar with it, you would be advised to give it a quick
35+
perusal. The major point is that the 'main' (formerly 'master') branch is
36+
reserved for official releases (which will be tagged), the 'develop' branch
37+
is used for ongoing development work and is the default branch, and we
38+
generally work off 'issue' branches named 'issue-#' where # is the GitHub
39+
issue number. (The last is not an absolute requirement, but rather a
40+
suggested approach.)
4041

4142
Finally, we recommend setting the git property 'core.autocrlf' to 'input'
4243
in your $HOME/.gitconfig file; e.g., that file should contain something
@@ -47,8 +48,7 @@ Overview:
4748

4849
Required Software:
4950
We use Maven for building. Maven 3.3.9 or later is required. You also need
50-
JDK 8 or later.
51-
[Note: If you use JDK 9 or later, there will be multiple
51+
JDK 8 or later. [Note: If you use JDK 9 or later, there will be multiple
5252
failures when you try to run 'mvn test' as well as some general warnings.
5353
See ESAPI GitHub issue #496 for details. We welcome volunteers to address
5454
this.]
@@ -106,7 +106,7 @@ Steps to work with ESAPI:
106106
9. Go to your personal, forked ESAPI GitHub repo (web interface) and create a
107107
'Pull Request' from your 'issue-#' branch.
108108
10. Back on your local personal laptop / desktop, merge your issue branch with
109-
your local 'develop' branch. I.e.
109+
your local 'develop' branch. I.e.,
110110
$ git checkout develop
111111
$ git merge issue-444
112112

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ before posting your issue.
134134
If believe you have found a vulnerability in ESAPI legacy, for the sake of the
135135
ESAPI community, please practice Responsible Disclosure. (Note: We will be sure
136136
you get credit and will work with you to create a GitHub Security Advisory, and
137-
if you so choose, to persue filing a CVE via the GitHub CNA.)
137+
if you so choose, to pursue filing a CVE via the GitHub CNA.)
138138

139139
You are of course encouraged to first search our GitHub issues list (see above)
140140
to see if it has already been reported. If it has not, then please contact
@@ -175,7 +175,7 @@ In mid-2014 ESAPI migrated all code and issues from Google Code to GitHub. This
175175
### What about the issues still located on Google Code?
176176
All issues from Google Code have been migrated to GitHub issues. We now
177177
use GitHut Issues for reporting everything *except* security vulnerabilities.
178-
Other bug tracking sites are undoubtably more advanced, but as developers,
178+
Other bug tracking sites are undoubtedly more advanced, but as developers,
179179
we do not want to spent time having to close issues from multiple bug-tracking
180180
systems. Therefore, until the synchronization happens with the Atlassian Jira
181181
instance that we have (but are not using; see GitHub issue #371), please

0 commit comments

Comments
 (0)