Thank you for considering contributing. Please review the guidelines below before making a contribution.
Before reporting, please check if an issue with the same content already exists.
When reporting a bug, please include the following information:
- Application version
- Terminal emulator and version being used
- Instructions to replicate the bug you found like : do x then y happens
- if posibble an error message found in the
manga-tui-error-logs.txtfile located where themanga-tuidirectory is, if you don't know the location of this directory run:
manga-tui --data-dir
# or
manga-tui -dMake sure you have installed cargo make
After cloning the repository run:
cargo makeIt will run all the ci workflow which consists of formatting, checking, building and testing the code (which includes both normal test and ignored tests)
after it is done a directory called ./test_results will be created which is where the download tests produce their output
To run only the download test:
cargo make download-allOr if you only want to run one download format
cargo make download epubNew features are always welcome but they need to have a issue associated first to discuss ways for a feature to be implemented, what the feature would do and how it would be implemented
On terminals which implement image protocols such as Wezterm iTerm2 there may be issues with how images are render, I have only used Wezterm on linux
manga-tui will not render images on any other terminal that does not have image protocol, keep this in mind before making a issue about the image support
Before making a pull request, please make an issue and then either fork this repo or make a branch that is intended to solve the issue