Skip to content

Commit e1af183

Browse files
committed
Assorted small fixes/improvements to root dir docs
This contains misc. formatting fixes and minor proofreading in the top-level documentation files, plus making the text in the LICENSE section of README.md have links both to external information about the license and to the license file itself. Note that the changes to the license file are just removal of excess whitespace (the extra blank line at the end, and spaces appearing at the end of lines).
1 parent e8c3085 commit e1af183

File tree

4 files changed

+23
-22
lines changed

4 files changed

+23
-22
lines changed

AUTHORS

+1
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,5 @@ Contributors are:
5252
-Joseph Hale <me _at_ jhale.dev>
5353
-Santos Gallegos <stsewd _at_ proton.me>
5454
-Wenhan Zhu <wzhu.cosmos _at_ gmail.com>
55+
5556
Portions derived from other open source works and are clearly marked.

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The following is a short step-by-step rundown of what one typically would do to contribute.
44

5-
- [fork this project](https://github.com/gitpython-developers/GitPython/fork) on GitHub.
5+
- [Fork this project](https://github.com/gitpython-developers/GitPython/fork) on GitHub.
66
- For setting up the environment to run the self tests, please run `init-tests-after-clone.sh`.
77
- Please try to **write a test that fails unless the contribution is present.**
88
- Try to avoid massive commits and prefer to take small steps, with one commit for each.

LICENSE

+17-18
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,29 @@
11
Copyright (C) 2008, 2009 Michael Trier and contributors
22
All rights reserved.
33

4-
Redistribution and use in source and binary forms, with or without
5-
modification, are permitted provided that the following conditions
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions
66
are met:
77

8-
* Redistributions of source code must retain the above copyright
8+
* Redistributions of source code must retain the above copyright
99
notice, this list of conditions and the following disclaimer.
1010

11-
* Redistributions in binary form must reproduce the above copyright
12-
notice, this list of conditions and the following disclaimer in the
11+
* Redistributions in binary form must reproduce the above copyright
12+
notice, this list of conditions and the following disclaimer in the
1313
documentation and/or other materials provided with the distribution.
1414

15-
* Neither the name of the GitPython project nor the names of
16-
its contributors may be used to endorse or promote products derived
15+
* Neither the name of the GitPython project nor the names of
16+
its contributors may be used to endorse or promote products derived
1717
from this software without specific prior written permission.
1818

19-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20-
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21-
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22-
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23-
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24-
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
25-
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26-
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27-
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28-
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
25+
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26+
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27+
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28+
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
2929
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30-

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Please have a look at the [contributions file][contributing].
177177

178178
- [User Documentation](http://gitpython.readthedocs.org)
179179
- [Questions and Answers](http://stackexchange.com/filters/167317/gitpython)
180-
- Please post on stackoverflow and use the `gitpython` tag
180+
- Please post on Stack Overflow and use the `gitpython` tag
181181
- [Issue Tracker](https://github.com/gitpython-developers/GitPython/issues)
182182
- Post reproducible bugs and feature requests as a new issue.
183183
Please be sure to provide the following information if posting bugs:
@@ -267,6 +267,7 @@ gpg --edit-key 4C08421980C9
267267

268268
### LICENSE
269269

270-
New BSD License. See the LICENSE file.
270+
[New BSD License](https://opensource.org/license/bsd-3-clause/). See the [LICENSE file](https://github.com/gitpython-developers/GitPython/blob/main/license).
271271

272-
[contributing]: https://github.com/gitpython-developers/GitPython/blob/master/CONTRIBUTING.md
272+
[contributing]: https://github.com/gitpython-developers/GitPython/blob/main/CONTRIBUTING.md
273+
[license]: https://github.com/gitpython-developers/GitPython/blob/main/license

0 commit comments

Comments
 (0)