Skip to content

Initial Migration of Fuzz Tests & Integration Scripts From the OSS-Fuzz Project Repo #1901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update documentation to include fuzzing specific info
As per discussion in #1889
  • Loading branch information
DaveLak committed Apr 12, 2024
commit d0c6ee62ad64a074ca885c0c2edbbc5074542b6e
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