diff --git a/README.md b/README.md index d2cfd89..a1dcc13 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,15 @@ jobs: ## Issues Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/autoflake_action/issues/new). + +## FAQ + +### Repository workflow settings + +To be able to push to your repository you will need to enable "Read and write permissions" for your repository. You can find these settings in the settings of the repository under Actions > General > Workflow Permissions. + +![Workflow Permissions](https://github.com/creyD/autoflake_action/assets/15138480/05d5d993-970f-4835-bfeb-2d067afcf352) + +If you do not set this, you might encounter this issue: + +![Sample error message](https://github.com/creyD/autoflake_action/assets/15138480/e71c814f-e7e9-4636-973b-750d6b950b84)