This document is for people wanting to contribute to anyrun repositories, or to write their own anyrun plugins.
This document provides general Contributing Guidelines. Check out the specific submodules Contributing Guidelines for further information.
- anyrun: Main project repository that contains all the information required for using Anyrun.
- interface: The raw interface crate for Anyrun and the plugins.
- macros: Macro crate used by both plugins and Anyrun.
- plugin: A crate to make building plugins easier.
The general process for contributing is as follows:
- Fork the repository you want to work on
- Create a new branch descriptive of you changes
- Commit all changes
- Open a pull request to the upstream repo
- Wait for your code to be reviewed and merged, be open to dialog on changes, update your branch if necessary
Format your code with rustfmt.
Catch mistakes and improve your code with clippy,
use the --all-targets -- --deny warnings flags and resolve all errors and warnings.