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 README dependencies link in PR body #176

Merged
merged 4 commits into from
Apr 25, 2024

Conversation

pshergie
Copy link
Contributor

@pshergie pshergie commented Apr 24, 2024

No issue

Motivation

wanted to improve DX

Screenshot or Video

pretty minor change for a video

Checklist

  • Don’t rush. Check all changes in PR again.
  • Run pnpm test.
  • Think about changing documentation.
    • If you added a script to scripts/, add a comment with a description.
    • If you added a new folder, add its description to the project’s README.md.
    • If you added config, describe how we use this tool in the config’s comment.
    • If you added something to the project’s architecture, describe it in the project’s README.md.
    • Try to focus on “why?”, not “how?”.
  • If you added a new dependency, check our requirements.
  • Think about testing
    • If you added a feature, add unit tests.
    • If you added a new state to the UI, add visual tests.
    • If you fixed the bug, think about preventing bug regression in the future.
  • If you changed web client:
    • Think about moving code to core/. What code will also be useful on other platforms?
    • Run pnpm size and check the difference in the JS bundle size. Is it relevant to the changes? Change the limit in web/.size-limit.json if necessary.
    • The UI was checked in Chrome and Firefox (and Safari or Epiphany if you have them).
    • Think about keyboard UX. Is it easy to use the new feature with only one hand on a keyboard? Is it easy to understand what keys to press?
    • Think about HTML semantics.
    • Think about accessibility. Check a11y recommendations. Think about how screen reader users will use the tool. Is it easy to use on a screen with bad contrast?
    • Think about translations.
    • Think about right-to-left languages. What parts of the screen should be mirrored for Arabic or Hebrew languages?
  • If you changed web/main/ files:
    • Do you need to backport styles changes to web/public/404.html or web/public/500.html?
    • Think about app loading styles inlined in index.html.
  • If you changed core/:
    • Think about making types more precise. Can you better explain data relations by type?
    • Think about conflict resolution. We don’t need some very smart changing merging; just 2 changes of the same item on different clients should not break the database. What if the user changes an item on one machine and removes it on another?
    • Think about log and storage migration.
  • If you changed English translations:
    • Change translation ID if you change the meaning of the text.

@pshergie pshergie marked this pull request as draft April 24, 2024 12:39
@pshergie pshergie marked this pull request as ready for review April 24, 2024 13:17
@pshergie pshergie requested a review from ai April 24, 2024 14:03
@@ -20,7 +20,7 @@ Fixes # (PUT ISSUE NUMBER AFTER #)
- If you added config, describe how we use this tool in the config’s comment.
- If you added something to the project’s architecture, describe it in the project’s `README.md`.
- Try to focus on “why?”, not “how?”.
- [ ] If you added a new dependency, check our [requirements](../README.md#dependencies).
- [ ] If you added a new dependency, check our [requirements](/hplush/slowreader/blob/main/README.md#dependencies).
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.

The case you described is not common as the file is intended to be interacted with through the pull request page but I fixed it though. Let's hope github doesn't change its URL soon

@pshergie pshergie requested a review from ai April 25, 2024 08:45
@ai ai merged commit 472daad into hplush:main Apr 25, 2024
1 check passed
@ai
Copy link
Contributor

ai commented Apr 25, 2024

Thanks. Now the link works.

@pshergie pshergie deleted the fix-pr-body-checklist-link branch April 25, 2024 08:46
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