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
ModelZoo
SOLOv2-pytorch
Commits
a99dbae7
Unverified
Commit
a99dbae7
authored
May 21, 2019
by
Kai Chen
Committed by
GitHub
May 21, 2019
Browse files
add contributing guide (#681)
parent
46b789d1
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
34 additions
and
0 deletions
+34
-0
CONTRIBUTING.md
CONTRIBUTING.md
+30
-0
README.md
README.md
+4
-0
No files found.
CONTRIBUTING.md
0 → 100644
View file @
a99dbae7
# Contributing to mmdetection
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 mmdetection
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.
-
If you are the author of some papers and would like to include your method to mmdetection,
please contact Kai Chen (chenkaidev[at]gmail[dot]com). 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.
### C++ and CUDA
We follow the
[
Google C++ Style Guide
](
https://google.github.io/styleguide/cppguide.html
)
.
\ No newline at end of file
README.md
View file @
a99dbae7
...
...
@@ -112,6 +112,10 @@ Please refer to [INSTALL.md](INSTALL.md) for installation and dataset preparatio
Please see
[
GETTING_STARTED.md
](
GETTING_STARTED.md
)
for the basic usage of mmdetection.
## Contributing
We appreciate all contributions to improve mmdetection. Please refer to
[
CONTRIBUTING.md
](
CONTRIBUTING.md
)
for the contributing guideline.
## Citation
...
...
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