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

Add documentation for keyboard shortcuts #3215

Merged
merged 6 commits into from
Jun 6, 2019

Conversation

SohamG
Copy link
Contributor

@SohamG SohamG commented Jun 3, 2019

Type of change

  • ✅ Documentation (non-code change)

Description and Context

  • Fixes Document keyboard shortcuts #3175
  • Add docs/KEYBINDS.md
  • Add reference to above file in README.md
  • Fix a small error in INSTALL.md in section "Packaging", link to keepassxreboot/keepassxc-packaging

Testing strategy

No code changes

Checklist:

  • ✅ I have read the CONTRIBUTING document. [REQUIRED]
  • ✅ My code follows the code style of this project. [REQUIRED]
  • ✅ All new and existing tests passed. [REQUIRED]
  • ✅ I have compiled and verified my code with -DWITH_ASAN=ON. [REQUIRED]
  • ✅ My change requires a change to the documentation, and I have updated it accordingly.

@CuredByLaughter
Copy link
Contributor

Thanks for the overview!
How will we know to update this file should the bindings change?

@SohamG
Copy link
Contributor Author

SohamG commented Jun 4, 2019

@PF93mc8y7erq92qTmTjJBysALa The only solution I can think of for that is to make it a PR requirement; @droidmonkey should I edit the pull request template file for this?

I could look into automating, but I think thats for another PR.

@CuredByLaughter
Copy link
Contributor

PR Requirement

Seems a relevant one is already listed:

✅ My change requires a change to the documentation, and I have updated it accordingly.
And that might be sufficient.

I think you are right - automating it (even just automating a test for it) could be another merge request.

Thanks again!

@SohamG
Copy link
Contributor Author

SohamG commented Jun 4, 2019 via email

@droidmonkey
Copy link
Member

I wouldn't bother automating it.

@droidmonkey droidmonkey added this to the v2.4.3 milestone Jun 6, 2019
@droidmonkey droidmonkey merged commit d5e544a into keepassxreboot:release/2.4.3 Jun 6, 2019
phoerious added a commit that referenced this pull request Jun 11, 2019
- Fix library loading issues in the Snap and macOS releases [#3247]
- Fix various keyboard navigation issues [#3248]
- Fix main window toggling regression when clicking the tray icon on KDE [#3258]
- Add documentation for keyboard shortcuts to source code distribution [#3215]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants