mirrors/mmclassification
1
0
Fork 0
mirror of https://github.com/open-mmlab/mmclassification.git synced 2025-06-03 17:01:33 +08:00
Code Issues Projects Releases Wiki Activity
mmclassification/.github/CONTRIBUTING.md
LXXXXR 400074c321
Add markdown lint in pre-commit hook (#106) 
* add mdlint

* remove duplicate check

* modify md files to pass linting check

* change mmcv download url

* remove torch1.4.0 version check

* remove torch1.4.0 version check
2020-12-02 19:42:45 +08:00

1.1 KiB
Raw Blame History

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 as the preferred code style. We use flake8 as the linter and yapf as the formatter. Please upgrade to the latest yapf (>=0.27.0) and refer to the configuration.

Before you create a PR, make sure that your code lints and is formatted by yapf.