Skip to content

Commit a99dbae

Browse files
authored
add contributing guide (open-mmlab#681)
1 parent 46b789d commit a99dbae

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to mmdetection
2+
3+
All kinds of contributions are welcome, including but not limited to the following.
4+
5+
- Fixes (typo, bugs)
6+
- New features and components
7+
8+
## Workflow
9+
10+
1. fork and pull the latest mmdetection
11+
2. checkout a new branch (do not use master branch for PRs)
12+
3. commit your changes
13+
4. create a PR
14+
15+
Note
16+
- If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.
17+
- If you are the author of some papers and would like to include your method to mmdetection,
18+
please contact Kai Chen (chenkaidev[at]gmail[dot]com). We will much appreciate your contribution.
19+
20+
## Code style
21+
22+
### Python
23+
We adopt [PEP8](https://www.python.org/dev/peps/pep-0008/) as the preferred code style.
24+
We use [flake8](http://flake8.pycqa.org/en/latest/) as the linter and [yapf](https://github.com/google/yapf) as the formatter.
25+
Please upgrade to the latest yapf (>=0.27.0) and refer to the [configuration](.style.yapf).
26+
27+
>Before you create a PR, make sure that your code lints and is formatted by yapf.
28+
29+
### C++ and CUDA
30+
We follow the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,10 @@ Please refer to [INSTALL.md](INSTALL.md) for installation and dataset preparatio
112112

113113
Please see [GETTING_STARTED.md](GETTING_STARTED.md) for the basic usage of mmdetection.
114114

115+
## Contributing
116+
117+
We appreciate all contributions to improve mmdetection. Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for the contributing guideline.
118+
115119

116120
## Citation
117121

0 commit comments

Comments
 (0)