31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
# Contributing to MMClassification
|
|
|
|
All kinds of contributions are welcome, including but not limited to the following.
|
|
|
|
- Fixes (typo, bugs)
|
|
- New features and components
|
|
|
|
## Workflow
|
|
|
|
1. Fork and pull the latest mmclassification
|
|
2. Checkout a new branch with a meaningful name (do not use master branch for PRs)
|
|
3. Commit your changes
|
|
4. Create a PR
|
|
|
|
Note
|
|
|
|
- If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.
|
|
- If you are the author of some papers and would like to include your method to mmclassification,
|
|
|
|
please contact Lei Yang (jerryyanglei@gmail). We will much appreciate your contribution.
|
|
|
|
## Code style
|
|
|
|
### Python
|
|
|
|
We adopt [PEP8](https://www.python.org/dev/peps/pep-0008/) as the preferred code style.
|
|
We use [flake8](http://flake8.pycqa.org/en/latest/) as the linter and [yapf](https://github.com/google/yapf) as the formatter.
|
|
Please upgrade to the latest yapf (>=0.27.0) and refer to the [configuration](.style.yapf).
|
|
|
|
>Before you create a PR, make sure that your code lints and is formatted by yapf.
|