Skip to content

Meta: Update issue/PR templates#4045

Merged
fregante merged 10 commits into
mainfrom
templates
Mar 3, 2021
Merged

Meta: Update issue/PR templates#4045
fregante merged 10 commits into
mainfrom
templates

Conversation

@fregante
Copy link
Copy Markdown
Member

@fregante fregante commented Mar 2, 2021

These explains better what we request and why. Also specify REAL URL because many unnecessarily post incomprehensible fake URLs for no good reason.

  • Add templates for meta/discussion and change requests

@fregante fregante added the meta Related to Refined GitHub itself label Mar 2, 2021
Comment thread .github/pull_request_template.md Outdated
Add some test URLs
1. Does this PR close/fix an existing issue? Write something like `Closes #10`
2. What pages does this PR affect? Include some URLs where you tested the code or where reviewers can test it.
3. Add a screenshot if your PR makes visual changes
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe include a few guidelines to make better screenshots? e.g.:

  • Clean up the area around the targeted element
  • Zoom on the page for small UI changes
  • Provide some context only if needed
  • Use the "Before" and "After" arrows

I could use those remainders myself :)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah I was thinking about guidelines for screenshots in the readme but those either go in the readme (we have guidelines for the description in there) or in contributing

This screenshot is only meant to demonstrate the feature for review, not for the readme. In fact multiple screenshots or gifs are encouraged. See #4046 and #4029

@fregante
Copy link
Copy Markdown
Member Author

fregante commented Mar 2, 2021

OT: @yakov116 let's chill if we get repetitive/unwanted suggestions in my new meta issue (4049, no linking) 🙏

@fregante fregante marked this pull request as ready for review March 2, 2021 18:57
@fregante fregante merged commit 2533d5c into main Mar 3, 2021
@fregante fregante deleted the templates branch March 3, 2021 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

meta Related to Refined GitHub itself

Development

Successfully merging this pull request may close these issues.

3 participants