First off, thank you for considering contributing to Weeb CLI! Your help is highly appreciated.
If you enjoy anime, tools, and the terminal, you are in the right place.
- Fork the repository on GitHub.
- Clone your fork locally:
git clone https://github.com/ewgsta/weeb-cli.git cd weeb-cli - Install dependencies in editable mode:
pip install -e .
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
- Make your changes in the codebase.
- To test your CLI changes locally, you can run
weeb-cliwhich should point to your active environment's script. - Try to write tests. They are located under the
tests/directory.pytest
- Commit your changes. Ensure your commit messages clearly describe what changed.
- Push to your fork and submit a Pull Request to the
mainbranch.
- Keep your pull requests focused on a single change, feature, or bugfix. This makes the review process smoother.
- Link any related issues to your PR so maintainers have context.
- Adhere to the existing code style (use Black/Flake8 for Python components).
- Update the documentation (
README.md,docs/md/tr/README.md, etc.) if your changes affect external behavior.
If you find a bug or have a suggestion, feel free to open an issue:
- Search existing issues before you create a new one to avoid duplicates.
- Provide as much context as possible. Mention the OS, Python version, and Weeb CLI version.
- Include a reproducible example, logs, or screenshots where applicable.
Since Weeb CLI supports multiple languages (en, tr, de, pl, etc.):
- Features adding texts to the user interface should modify the corresponding JSON files in the
locales/directory (en.json,tr.json,de.json,pl.json, etc.).
Thank you again for your contribution!