3
3
Getting Started:
4
4
If you have not already done so, go back and read the section
5
5
"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.
7
7
8
8
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.
12
12
Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/
13
13
for details and plan accordingly.
14
14
@@ -21,22 +21,23 @@ Finding Something Interesting to Work on:
21
21
or "help wanted", those are good places to start for someone not yet
22
22
familiar with the ESAPI code base.
23
23
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
25
25
what it is. Then if you want to work on a particular issue, we can assign
26
26
it to you so someone else won't take it.
27
27
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
+
29
30
30
31
Overview:
31
32
We are following the branching model described in
32
33
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.)
40
41
41
42
Finally, we recommend setting the git property 'core.autocrlf' to 'input'
42
43
in your $HOME/.gitconfig file; e.g., that file should contain something
@@ -47,8 +48,7 @@ Overview:
47
48
48
49
Required Software:
49
50
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
52
52
failures when you try to run 'mvn test' as well as some general warnings.
53
53
See ESAPI GitHub issue #496 for details. We welcome volunteers to address
54
54
this.]
@@ -106,7 +106,7 @@ Steps to work with ESAPI:
106
106
9. Go to your personal, forked ESAPI GitHub repo (web interface) and create a
107
107
'Pull Request' from your 'issue-#' branch.
108
108
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.,
110
110
$ git checkout develop
111
111
$ git merge issue-444
112
112
0 commit comments