Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

CONTRIBUTING.md 4.8KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. ## Contributing to YOLOv5 🚀
  2. We love your input! We want to make contributing to YOLOv5 as easy and transparent as possible, whether it's:
  3. - Reporting a bug
  4. - Discussing the current state of the code
  5. - Submitting a fix
  6. - Proposing a new feature
  7. - Becoming a maintainer
  8. YOLOv5 works so well due to our combined community effort, and for every small improvement you contribute you will be helping push the frontiers of what's possible in AI 😃!
  9. ## Submitting a Pull Request (PR) 🛠️
  10. Submitting a PR is easy! This example shows how to submit a PR for updating `requirements.txt` in 4 steps:
  11. ### 1. Select File to Update
  12. Select `requirements.txt` to update by clicking on it in GitHub.
  13. <p align="center"><img width="800" alt="PR_step1" src="https://user-images.githubusercontent.com/26833433/122260847-08be2600-ced4-11eb-828b-8287ace4136c.png"></p>
  14. ### 2. Click 'Edit this file'
  15. Button is in top-right corner.
  16. <p align="center"><img width="800" alt="PR_step2" src="https://user-images.githubusercontent.com/26833433/122260844-06f46280-ced4-11eb-9eec-b8a24be519ca.png"></p>
  17. ### 3. Make Changes
  18. Change `matplotlib` version from `3.2.2` to `3.3`.
  19. <p align="center"><img width="800" alt="PR_step3" src="https://user-images.githubusercontent.com/26833433/122260853-0a87e980-ced4-11eb-9fd2-3650fb6e0842.png"></p>
  20. ### 4. Preview Changes and Submit PR
  21. Click on the **Preview changes** tab to verify your updates. At the bottom of the screen select 'Create a **new branch** for this commit', assign your branch a descriptive name such as `fix/matplotlib_version` and click the green **Propose changes** button. All done, your PR is now submitted to YOLOv5 for review and approval 😃!
  22. <p align="center"><img width="800" alt="PR_step4" src="https://user-images.githubusercontent.com/26833433/122260856-0b208000-ced4-11eb-8e8e-77b6151cbcc3.png"></p>
  23. ### PR recommendations
  24. To allow your work to be integrated as seamlessly as possible, we advise you to:
  25. - ✅ Verify your PR is **up-to-date with origin/master.** If your PR is behind origin/master an automatic [GitHub actions](https://github.com/ultralytics/yolov5/blob/master/.github/workflows/rebase.yml) rebase may be attempted by including the /rebase command in a comment body, or by running the following code, replacing 'feature' with the name of your local branch:
  26. ```bash
  27. git remote add upstream https://github.com/ultralytics/yolov5.git
  28. git fetch upstream
  29. git checkout feature # <----- replace 'feature' with local branch name
  30. git merge upstream/master
  31. git push -u origin -f
  32. ```
  33. - ✅ Verify all Continuous Integration (CI) **checks are passing**.
  34. - ✅ Reduce changes to the absolute **minimum** required for your bug fix or feature addition. _"It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is."_ -Bruce Lee
  35. ## Submitting a Bug Report 🐛
  36. If you spot a problem with YOLOv5 please submit a Bug Report!
  37. For us to start investigating a possibel problem we need to be able to reproduce it ourselves first. We've created a few short guidelines below to help users provide what we need in order to get started.
  38. When asking a question, people will be better able to provide help if you provide **code** that they can easily understand and use to **reproduce** the problem. This is referred to by community members as creating a [minimum reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). Your code that reproduces the problem should be:
  39. * ✅ **Minimal** – Use as little code as possible that still produces the same problem
  40. * ✅ **Complete** – Provide **all** parts someone else needs to reproduce your problem in the question itself
  41. * ✅ **Reproducible** – Test the code you're about to provide to make sure it reproduces the problem
  42. In addition to the above requirements, for [Ultralytics](https://ultralytics.com/) to provide assistance your code should be:
  43. * ✅ **Current** – Verify that your code is up-to-date with current GitHub [master](https://github.com/ultralytics/yolov5/tree/master), and if necessary `git pull` or `git clone` a new copy to ensure your problem has not already been resolved by previous commits.
  44. * ✅ **Unmodified** – Your problem must be reproducible without any modifications to the codebase in this repository. [Ultralytics](https://ultralytics.com/) does not provide support for custom code ⚠️.
  45. If you believe your problem meets all of the above criteria, please close this issue and raise a new one using the 🐛 **Bug Report** [template](https://github.com/ultralytics/yolov5/issues/new/choose) and providing a [minimum reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) to help us better understand and diagnose your problem.
  46. ## License
  47. By contributing, you agree that your contributions will be licensed under the [GPL-3.0 license](https://choosealicense.com/licenses/gpl-3.0/)