Skip to content

Commit

Permalink
Update documentation to include fuzzing specific info
Browse files Browse the repository at this point in the history
As per discussion in #1889
  • Loading branch information
DaveLak committed Apr 12, 2024
1 parent 55c30a3 commit d0c6ee6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@ The following is a short step-by-step rundown of what one typically would do to
- Try to avoid massive commits and prefer to take small steps, with one commit for each.
- Feel free to add yourself to AUTHORS file.
- Create a pull request.

## Fuzzing Test Specific Documentation

For details related to contributing to the fuzzing test suite and OSS-Fuzz integration, please
refer to the dedicated [fuzzing README](./fuzzing/README.md).
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,5 +240,17 @@ Please have a look at the [contributions file][contributing].

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

> [!NOTE]
> There are two special case files located in the `fuzzzing/` directory that are licensed differently:
>
> `fuzz_config.py` and `fuzz_tree.py` were migrated here from the OSS-Fuzz project repository where they were initially
> created and retain the original licence and copyright notice (Apache License, Version 2.0 and Copyright 2023 Google
> LLC respectively.)
>
> - **These files do not impact the licence under which GitPython releases or source code are distributed.**
> - The files located in the `fuzzzing/` directory are part of the project test suite and neither packaged nor distributed as
part of any release.


[contributing]: https://github.com/gitpython-developers/GitPython/blob/main/CONTRIBUTING.md
[license]: https://github.com/gitpython-developers/GitPython/blob/main/LICENSE

0 comments on commit d0c6ee6

Please sign in to comment.