diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a4fa56d77..72a5555499 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,7 @@ Documents under the docs/ directory will help you to change the specification. T * [Fixing a definition, the complete story](docs/validation-example.md) -## Send your pull request +## Send your pull request from a branch To fix any style issues and generate the outputs (that we store in git), please run: @@ -56,5 +56,4 @@ Then, follow those steps: - If the API is unusable without the change -> every supported version - If the API is usable, but fix is on the response side -> every supported version - If the API is usable, but fix is on the request side -> no backport, unless the API is _partially_ usable and the fix unlocks a missing feature that has no workaround - - +- Send the pull request from a branch, **not a fork** diff --git a/README.md b/README.md index 440f3192d9..85b7fbcb5e 100644 --- a/README.md +++ b/README.md @@ -245,7 +245,7 @@ If you need to download the recordings again, run `make validate-no-cache api=xp Once you see the errors, you can fix the original definition in `/specification` and then run the command again until the types validator does not trigger any new error. -Finally open a pull request with your changes. +Finally open a pull request with your changes. Please open it from a branch in the repository, and not from a fork. ## Documentation