-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update PR template #349
base: main
Are you sure you want to change the base?
Conversation
Related to ATL-7849 and this is also a try to use a text edior to write the commit message on more than one line Signed-off-by: Michael Breuninger <michael.breuninger@iohk.io>
Open for discussion: the markdown block to highlight user facing information for the changelog or release note. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice template, @mkbreuningIOHK
In my opinion, it's too lengthy.
Let's see how it will work and collect feedback from other engineers.
Signed-off-by: Yurii Shynbuiev <yurii.shynbuiev@iohk.io>
I was thinking for something more like this
🚀 🌕 |
Just to make sure, it is not lengthy for the real PR as the HTML block were used: when you change to preview, all will be removed automatically: so there is no need for the user to remove anything. What I can do is simplify the text under the HTML block with the input from @FabioPinheiro |
I don't mine. But "PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING" is also like that acknowledge that you read that. |
What was changed and what it is solving
Related to ATL-7849. The PR template needed to be updated taking the feedback from the engineers into account.
The PR you are reading now is using the proposed PR template.
The changes are:
How it was tested
The proposed PR was copied and pasted to this actual PR to see the preview.
Release Notes / Changelog