Clarify `gitDir` usage?

I spent quite some time trying to figure out why my lint-staged config didn’t work:

  "lint-staged": {
    "gitDir": "../",
    "linters": {
      "src/**/*.{js,jsx,json}": [
        "prettier-eslint --write --single-quote",
        "git add"
      ]
    }
  },

Then I tried to define packages/myapp/src/**/*{js,jsx,json} and it worked.

May you add somewhere in the README this information? (that any pattern must use as root the ones defined as gitDir)

[sudo-suhas]

I just tested this out and I think the current behavior needs to be changed. When I am defining the lint-staged config inside a package, I shouldn’t have to think about relative paths from a parent folder. And I like the idea of automatically detecting the git directory. That should kill a ton of birds in one shot 😛

[sudo-suhas]

Apologies, I somehow missed replying to this. Since release notes serve as our migration guide, it would make sense to show all the changes required for upgrading to lint-staged@5. I have updated the release notes, please take a look.

If you want to include this information in the readme as well, let me know. I can make a PR.