Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions to make sure your suggestion isn't a duplicate.
- Make sure each list item is useful before adding it.
- Create individual pull requests/issues for each suggestion.
- Use title-casing (AP style) in the following format mentioned here PR Format.
- If a similar named plugin exists, ONLY THEN you are allowed to add your name in the plugin name. Refer bookmarks section.
- Link additions should be added in alphabetical order in the relevant category.
- New categories or changes to the existing categorization are welcome.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request and commit should have a useful title.
- Annotate your PR to clarify what you did if the diff is confusing.
Thank you for your suggestions!
If you would like to add a plugin, flavor, etc. of yazi to the list, here is how you should do it -
- Fork the repository
- Edit the Readme ensuring the PR Guidelines are being followed
- Update the Table of Contents (if needed)
- Commit and create a PR with its name and content abiding by the PR Guidelines
If you are asked to edit your PR due to spelling errors or because your PR didn't match the awesome-yazi list guidelines, please make suitable changes in your fork. This will automatically be reflected in the PR for further checking.
The plugin added will be reviewed before adding before any possible malicious additions in your and will also be frequently checked upon. This is to prevent any milicious plugin from reaching to the yazi community through awesome-yazi. Please cooperate with us. Thank you!