Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
MMCV
Commits
d1abbca1
Unverified
Commit
d1abbca1
authored
Jul 31, 2019
by
Kai Chen
Committed by
GitHub
Jul 31, 2019
Browse files
Create CONTRIBUTING.md (#102)
parent
95b87687
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
32 additions
and
0 deletions
+32
-0
CONTRIBUTING.md
CONTRIBUTING.md
+32
-0
No files found.
CONTRIBUTING.md
0 → 100644
View file @
d1abbca1
# Contributing to mmcv
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 mmcv
2.
checkout a new branch (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.
## Code style
### Python
We adopt
[
PEP8
](
https://www.python.org/dev/peps/pep-0008/
)
as the preferred code style.
We use the following tools for linting and formatting:
-
[
flake8
](
http://flake8.pycqa.org/en/latest/
)
: linter
-
[
yapf
](
https://github.com/google/yapf
)
: formatter
-
[
isort
](
https://github.com/timothycrosley/isort
)
: sort imports
Style configurations of yapf and isort can be found in
[
.style.yapf
](
.style.yapf
)
and
[
.isort.cfg
](
.isort.cfg
)
.
>Before you create a PR, make sure that your code lints and is formatted by yapf.
### C++ and CUDA
We follow the
[
Google C++ Style Guide
](
https://google.github.io/styleguide/cppguide.html
)
.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment