Skip to content
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.

Sign up for GitHub

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

Add overrides note to readme #602

Merged
merged 1 commit into from
Mar 5, 2024
Merged

Add overrides note to readme #602

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,19 @@ or [prediction](https://cloud.google.com/prediction/docs/developer-guide).

* Commit the downloaded discovery documents and generated packages.

### Overrides

If you ever need to ignore a specific API method or make a manual change to anything inside `discovery/`,
you should add the relevant diff to the `overrides/` directory.

* Make changes to the `overrides/<desired-api>.json` file.
* Run `git diff overrides/<desired-api>.json > overrides/<name>.diff` to create a diff file.

**Note:**
The name of the diff file is not important, but if possible, it is advised to associate the name
with the relevant GitHub issue. For example, if your manual change is related to issue #123,
then the diff file should be named `i123.diff`.

## What next?

* Read the README and the code for the packages on pub.dev:
Expand Down
Loading