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

Fix pull request template's markdown, reduce the required content #385

Open
tormi opened this issue Jan 5, 2024 · 3 comments
Open

Fix pull request template's markdown, reduce the required content #385

tormi opened this issue Jan 5, 2024 · 3 comments

Comments

@tormi
Copy link
Member

tormi commented Jan 5, 2024

The current pull request template has too many elements and content. Let's try to reduce it to a reasonable level.

Also, there are several syntax issues with the pull request template markdown:

Screenshot 2024-01-05 at 19 04 11
@tormi
Copy link
Member Author

tormi commented Jan 5, 2024

We should probably introduce the markdown validation check, too.

@sampoturve
Copy link
Contributor

I wonder whether the "Best practices" section is something that should be rethinked (or removed even), as it currently only provides a summary for accessibility. There are basically million best practices one could list here, and like the accessibility things, they should already be required on the definition of done of everything.

@tormi
Copy link
Member Author

tormi commented Apr 19, 2024

I totally agree. PR template should be really minimal, precise and not an obstacle as it's now (at least for me).
.

sampoturve added a commit that referenced this issue Apr 19, 2024
- Removed 'Best practices' section for being redundant
- Add square brackets for all the texts that should be replaced
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

No branches or pull requests

2 participants