docs/CONTRIBUTING.md

Contributing to Real-ESRGAN

:art: Real-ESRGAN needs your contributions. Any contributions are welcome, such as new features/models/typo fixes/suggestions/maintenance, etc. See CONTRIBUTING.md. All contributors are list here.

We like open-source and want to develop practical algorithms for general image restoration. However, individual strength is limited. So, any kinds of contributions are welcome, such as:

• New features
• New models (your fine-tuned models)
• Bug fixes
• Typo fixes
• Suggestions
• Maintenance
• Documents
• etc

Workflow

1. Fork and pull the latest Real-ESRGAN repository
2. Checkout a new branch (do not use master branch for PRs)
3. Commit your changes
4. Create a PR

Note:

1. Please check the code style and linting
   1. The style configuration is specified in setup.cfg
   2. If you use VSCode, the settings are configured in .vscode/settings.json
2. Strongly recommend using pre-commit hook. It will check your code style and linting before your commit.
   1. In the root path of project folder, run pre-commit install
   2. The pre-commit configuration is listed in .pre-commit-config.yaml
3. Better to open a discussion before large changes.
   1. Welcome to discuss :sunglasses:. I will try my best to join the discussion.

TODO List

:zero: The most straightforward way of improving model performance is to fine-tune on some specific datasets.

Here are some TODOs:

• optimize for human faces
• optimize for texts
• support controllable restoration strength

:one: There are also several issues that require helpers to improve. If you can help, please let me know :smile: