Skip to content
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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update PR template #349

wants to merge 2 commits into from

Conversation

mkbreuningIOHK
Copy link
Contributor

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:

  • Simplify by keeping two sections only: what is changed and how it was tested
  • Remove the checklist
  • Use HTML comments instead
  • Add a markdown block section to trigger a discussion on the automation for release note

How it was tested

The proposed PR was copied and pasted to this actual PR to see the preview.

Release Notes / Changelog

None

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>
@mkbreuningIOHK
Copy link
Contributor Author

Open for discussion: the markdown block to highlight user facing information for the changelog or release note.
It could be used for automation to create release notes from those sections only.
I saw a few repositories doing that. E.g: Kubernetes and Dockers
We can remove it in a first iteration but I thought it is a good idea. Like adding breaking change there.

Copy link
Member

@yshyn-iohk yshyn-iohk left a 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>
Copy link

Integration Test Results

 5 files  ±0   5 suites  ±0   12s ⏱️ -1s
17 tests ±0  17 ✅ ±0  0 💤 ±0  0 ❌ ±0 
20 runs  ±0  20 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 4b0454a. ± Comparison against base commit f7cb882.

@FabioPinheiro
Copy link
Contributor

FabioPinheiro commented Sep 27, 2024

I was thinking for something more like this

**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**

If it's your first PR on this repository you should:
- Read the [project's guideline](https://github.com/hyperledger/identus/blob/main/CONTRIBUTING.md).

Please ensure that:
- PR title MUST follow the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/).
- PR description MUST have a short summarize of the changes submitted. Including reference any issue/ticket/PR/ADR (Architecture Decision Record) relevant.
- All commit MUST be [Sing (GPG)](???) and free of Copyright [DCO](???)
- When adding third-party dependencies it MUST be included in the [Allowlist](https://toc.hyperledger.org/governing-documents/allowed-third-party-license-policy.html#approved-licenses-for-allowlist).

Thanks for submitting a Pull Request and help make this project awesome! :rocket: :stars:

🚀 🌕
🚀 🌠

@mkbreuningIOHK
Copy link
Contributor Author

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.
This is how it looks when you click on Preview and the source when it is opened for the first time. See screenshots below.

What I can do is simplify the text under the HTML block with the input from @FabioPinheiro

image

a PR is opened for the first time will show:
image

@FabioPinheiro
Copy link
Contributor

I don't mine. But "PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING" is also like that acknowledge that you read that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants