Is your feature request related to a problem? Please describe.
It is likely that users/contributors will encounter issues while using / working on RA, whose resolution may not be immediately obvious. Examples:
- Issues with GitHub PATs permissions
- Repository settings need to be updated in a fork / some branches may need to be pushed
- Classic branch protection rule vs rulesets
Describe the solution you'd like
A troubleshoot.md file that presents commonly-encountered issues / blockers and how to resolve them.
This would be a complement to existing error messages and documentation.
Describe alternatives you've considered
- Letting users figure out the solution by themselves
- Extending error messages / suggested resolution.
--> this may be cumbersome and redundant if we're trying to address all possible issues in each plugin error message.
Additional context
N/A
Is your feature request related to a problem? Please describe.
It is likely that users/contributors will encounter issues while using / working on RA, whose resolution may not be immediately obvious. Examples:
Describe the solution you'd like
A
troubleshoot.mdfile that presents commonly-encountered issues / blockers and how to resolve them.This would be a complement to existing error messages and documentation.
Describe alternatives you've considered
--> this may be cumbersome and redundant if we're trying to address all possible issues in each plugin error message.
Additional context
N/A