Skip to content

Commit d0c6ee6

Browse files
committedApr 12, 2024
Update documentation to include fuzzing specific info
As per discussion in #1889
1 parent 55c30a3 commit d0c6ee6

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed
 

‎CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,8 @@ The following is a short step-by-step rundown of what one typically would do to
88
- Try to avoid massive commits and prefer to take small steps, with one commit for each.
99
- Feel free to add yourself to AUTHORS file.
1010
- Create a pull request.
11+
12+
## Fuzzing Test Specific Documentation
13+
14+
For details related to contributing to the fuzzing test suite and OSS-Fuzz integration, please
15+
refer to the dedicated [fuzzing README](./fuzzing/README.md).

‎README.md

+12
Original file line numberDiff line numberDiff line change
@@ -240,5 +240,17 @@ Please have a look at the [contributions file][contributing].
240240

241241
[3-Clause BSD License](https://opensource.org/license/bsd-3-clause/), also known as the New BSD License. See the [LICENSE file][license].
242242

243+
> [!NOTE]
244+
> There are two special case files located in the `fuzzzing/` directory that are licensed differently:
245+
>
246+
> `fuzz_config.py` and `fuzz_tree.py` were migrated here from the OSS-Fuzz project repository where they were initially
247+
> created and retain the original licence and copyright notice (Apache License, Version 2.0 and Copyright 2023 Google
248+
> LLC respectively.)
249+
>
250+
> - **These files do not impact the licence under which GitPython releases or source code are distributed.**
251+
> - The files located in the `fuzzzing/` directory are part of the project test suite and neither packaged nor distributed as
252+
part of any release.
253+
254+
243255
[contributing]: https://github.com/gitpython-developers/GitPython/blob/main/CONTRIBUTING.md
244256
[license]: https://github.com/gitpython-developers/GitPython/blob/main/LICENSE

0 commit comments

Comments
 (0)
Please sign in to comment.