sap-linuxlab
feat(.github/ISSUE_TEMPLATE): add bug and feature templates
Description
Since the contributions are increasing it might be helpful to have a templates to apply a bug report or feature request.
If this pr will be merged when someone want to open a pr can choose between:
- bug report
- feature request
- blank issue (by config we can also remove this possibility)
If for example the user want to apply a bug report this is the form that he/she/they have:
He/she/they have to fill out all the required elements in order to submit.
How to try the templates
Just use my fork: https://github.com/Wabri/community.sap_install/issues/new/choose
Example of submit
You can find at this link => https://github.com/Wabri/community.sap_install/issues/142
Additional infos
To start using it you will need to merge to main.
Question
Can be useful also for the other repositories?
Title standardisation through automation
I've added an automation that fill the title by following this standard:
[Bug] <role_name> on <os_family>: <short_description>
and
[Feature] <role_name> on <os_family>: <short_description>
The role name and os family is written only if applicable.
Checks
For now I've added a couple of checks for the titles:
- the object of the title
[Bug]or[Feature]should be link with labelsbugorenhancement. Example (see the comment in the issue linked): https://github.com/Wabri/community.sap_install/issues/141 - the title should include a short description. Example (see the comment in the issue linked): https://github.com/Wabri/community.sap_install/issues/139
Title update itself
Once the user create a issue that follow the standard, the automation will fill with the information found in the issue description. For example an issue with this title [Bug]: something dont work become [Bug] sap_ha_pacemaker_cluster on RHEL: something dont work with sap_ha_pacemaker_cluster taken from the issue description same for RHEL.
Here an example: https://github.com/Wabri/community.sap_install/issues/140