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

Conversation

pavinduLakshan
Copy link
Contributor

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.

$subject

@@ -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.

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

Successfully merging this pull request may close these issues.

2 participants