Contributing
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:
.
- 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.
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
AutoKey doesn't have its own platform for accepting donations, but the AutoKey community has shown an interest in having access to one and is currently trying out the Opire platform to put bounties on AutoKey issues. This platform seems to be especially suitable for the AutoKey project because it allows community members to specify the type of development they'd like to see.
Opire is a reward platform that provides a convenient way for community members to incentivize development on specific issues in open-source programs by offering financial rewards that are handled directly between the community members and the developers.
A reward is a bounty that anyone can create for any issue, with the minimum amount for a reward being $20. Anyone can also add to an existing reward to increase it and anyone can claim a reward if they earn it by solving an issue and submitting an accepted pull request.
A claim is a request for payment based on the completion of the specified task that has one or more rewards associated with it. A developer who solves an issue can use Opire to file a claim for the reward. The claim automatically triggers a notification to be sent to each creator of any rewards associated with that task letting them know that the issue has been solved and payment is due. It's then up to the reward creators to review the claim, examine the pull request, and decide whether or not to accept it as completion of the task and the solution to the reward issue. If the pull request is accepted, payment is made to the claimant by the reward creator(s).
Payment of rewards is done on the honor system. If a person repeatedly creates awards and fails to pay for them when the issues have been solved, that person will no longer be able to create new rewards until the existing ones are paid in full.
Full documentation is available here and a video showing how it works is available here.
AutoKey has not yet installed the Opire bot that offers commands to use in any AutoKey issue or AutoKey pull request to create or manage rewards without having to log in to the Opire website. For now, community members can create or pay rewards on the Opire website.
- Log in to the Opire website using your GitHub account.
- Click My dashboard in the left pane.
- Click Rewards in the left pane.
- Click the Create a new reward button in the right pane to create a new reward, providing the URL of the GitHub issue and the amount of the reward.
When a person who offered a reward gets a notification that the issue has been solved:
- Verify that the pull request satisfies the reward. Below are some things to consider when doing this:
- Check whether or not the name of the pull request's author matches that of the claimant.
- Check whether or not the pull request has been merged.
- Test out the code for that pull request to see if the issue has been solved by cloning the pull request and running the clone.
- Consider whether you, the donor, are satisfied with the resolution of the issue. If you have concerns, document them in the issue's comments section.
- Use the dashboard on the Opire website to pay the full reward amount to the developer directly via Stripe. Note that the total cost will consist of the reward amount plus the Stripe fee ($0.85 + 5.25%) and the Opire fee (4% of the reward) for handling the transaction.