Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
Swin-Transformer-Object-Detection
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to JiHu GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
wanggh
Swin-Transformer-Object-Detection
Commits
a99dbae7
Unverified
Commit
a99dbae7
authored
5 years ago
by
Kai Chen
Committed by
GitHub
5 years ago
Browse files
Options
Downloads
Patches
Plain Diff
add contributing guide (#681)
parent
46b789d1
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING.md
+30
-0
30 additions, 0 deletions
CONTRIBUTING.md
README.md
+4
-0
4 additions, 0 deletions
README.md
with
34 additions
and
0 deletions
CONTRIBUTING.md
0 → 100644
+
30
−
0
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
This diff is collapsed.
Click to expand it.
README.md
+
4
−
0
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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment