Contributing - autokey/autokey GitHub Wiki

This project welcomes all sorts of help. Below are a few suggestions to get started:

  • Adding to or editing the documentation.
  • Adding to or editing the wiki with documentation, example scripts, workflow ideas, and other content.
  • Answering questions and contributing to discussions in places like Google Groups, Reddit, and Stack Exchange that let other users and developers know we exist.
  • Contributing code by adding new features, updating existing code, or fixing issues.
  • Finding anything you feel you can change in the AutoKey project and making the change yourself.
  • Providing user community support, feedback, and general participation.
  • Sharing your expertise with CI, CD, git, GitHub, Python, etc., in our community.
  • Signing up with CodeTriage to receive a daily email with a link to an open AutoKey issue that needs help: Open Source Helpers.
  • Submitting feature requests and/or bug reports.
  • Testing and recreating issues in various distributions.
  • Testing changes, new features, betas, and new releases.
  • Writing articles about AutoKey.

Before embarking on any major effort, it's a good idea to discuss what you'd like to do on the Gitter platform to make sure it has a good chance of being accepted and to draw on our experience as to the best way to proceed.

Contributing code

Autokey is currently undergoing large changes on its develop branch. If you are writing code for anything other than small bugfixes, you should base off that branch. It is very far ahead of master, and has tidier code.

develop is the only branch with a working test framework, which you should do your best to use for code you contribute. Currently test coverage is very low, but that should not be an excuse for making it worse---please include tests for your code. Feel free to ask for help with writing tests in your PR comments.

Finally, please read CONTRIBUTERS.rst on that same branch.

--- BlueDrink9, 2020-10-06