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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 38 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,38 @@
### Description:
Summarize the changes you're submitting in a few sentences, including Jira ticket ATL-xxxx if applicable.
Link to any discussion, related issues, and bug reports to give the context and help the reviewer understand the PR.

### Alternatives Considered (optional):
Link to existing ADR (Architecture Decision Record), if any. If relevant, describe other approaches explored and the selected approach. Documenting why the methods were not selected will create a knowledge base for future reference, helping prevent others from revisiting less optimal ideas.

### Checklist:
- [ ] My PR follows the contribution guidelines of this project
- [ ] My PR is free of third-party dependencies that don't comply with the [Allowlist](https://toc.hyperledger.org/governing-documents/allowed-third-party-license-policy.html#approved-licenses-for-allowlist)
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have checked the PR title to follow the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/)

<!--
Thanks for submitting a Pull Request (PR)!
Before submitting your PR, ensure the following:
- The code follows the project's guideline https://github.com/hyperledger/identus/blob/main/CONTRIBUTING.md.
- The issue related to this PR is mentioned by writing.
- Refer to an issue from this repository by writing: fixes #xxxx.
- Refer to an issue from another repository by writing: fixes `owner/repository#issue_number`. For example: `hyperledger/identus-cloud-agent#12`.
- The ADR (Architecture Decision Record) related to this PR, if any, is linked from https://github.com/hyperledger/identus-docs/tree/main/documentation/adrs/decisions. Use the format [ADR title](ADR address).
- The following is a checklist to guide you through the PR:
- My PR is free of third-party dependencies that don't comply with the [Allowlist](https://toc.hyperledger.org/governing-documents/allowed-third-party-license-policy.html#approved-licenses-for-allowlist).
- I have checked the PR title to follow the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/).
- I have commented my code, particularly in hard-to-understand areas.
- I have made corresponding changes to the documentation.
- I have added tests that prove my fix is effective or that my feature works and no regression was introduced by my PR.
- No new TODOs or FIXMEs added without any justification in the below description.
- Finally, assign reviewers and indicate what kind of feedback you are expecting.

Provide the following information in basic English for the community to understand.
Do not leave any section empty, write "N/A" if not applicable.
-->

## What was changed and what it is solving

## How it was tested

## Release Notes / Changelog
<!--
Write a short (one line) summary that describes the changes in this
pull request for inclusion in the changelog.
This is what will be user facing in the release note.
If there is no need, write "None".
It must be placed inside the below triple backticks section:
-->
```markdown changelog

```

2 changes: 1 addition & 1 deletion .github/workflows/integration-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ jobs:
./gradlew reports

- name: Upload artifacts
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v3
with:
name: e2e-tests-result
path: ${{ env.REPORTS_DIR }}
Expand Down
Loading