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

Update PR template and delete unused issue template #640

Closed
wants to merge 1 commit into from
Closed
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
49 changes: 49 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## Purpose
<!-- Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc. -->
Copy link
Contributor

@DilshanSenarath DilshanSenarath Aug 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to check with a person who has the context to see if converting this to comments is acceptable, as this has been the behavior since the repository was created.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally this information should only be visible to the PR author in edit mode and provides no value to anyone who reads the PR description. In the current way, it is very common for PR authors to mix the actual content with these "instructions", so everything is inside blockquotes. On the other hand, removing these placeholder text per each PR is tedious.

We did the same change in identity-apps repo and it's saving us some time when creating pull requests, so thought to do the same change here. anyways, will check with the team and get back.


## Goals
<!-- Describe the solutions that this feature/fix will introduce to resolve the problems described above -->

## Approach
<!-- Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email [email protected] to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here. -->

## User stories
<!-- Summary of user stories addressed by this change -->

## Release note
<!--Brief description of the new feature or bug fix as it will appear in the release notes -->

## Documentation
<!-- Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact -->

## Training
<!-- Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable -->

## Certification
<!-- Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to [email protected] and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why. -->

## Marketing
<!-- Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable -->

## Automation tests
- Unit tests
<!-- Code coverage information -->
- Integration tests
<!-- Details about the test cases and coverage -->

## Security checks
- [ ] Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines?
- [ ] Ran FindSecurityBugs plugin and verified report?
- [ ] Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets?

## Samples
<!-- Provide high-level details about the samples related to this feature -->

## Related PRs
<!-- List any other related PRs -->

## Migrations (if applicable)
<!-- Describe migration steps and platforms on which migration has been tested -->

## Test environment
<!-- List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested -->
18 changes: 0 additions & 18 deletions issue_template.md

This file was deleted.

52 changes: 0 additions & 52 deletions pull_request_template.md

This file was deleted.

Loading