CloudAnts commited on
Commit
3f626dc
Β·
1 Parent(s): a12665e
Files changed (2) hide show
  1. CONTRIBUTING.md +0 -96
  2. ReadMe.md +0 -9
CONTRIBUTING.md DELETED
@@ -1,96 +0,0 @@
1
- # Contributing to YOLOv8 πŸš€
2
-
3
- We love your input! We want to make contributing to YOLOv8 as easy and transparent as possible, whether it's:
4
-
5
- - Reporting a bug
6
- - Discussing the current state of the code
7
- - Submitting a fix
8
- - Proposing a new feature
9
- - Becoming a maintainer
10
-
11
- YOLOv8 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 πŸ˜ƒ!
12
-
13
- ## Submitting a Pull Request (PR) πŸ› οΈ
14
-
15
- Submitting a PR is easy! This example shows how to submit a PR for updating `requirements.txt` in 4 steps:
16
-
17
- ### 1. Select File to Update
18
-
19
- Select `requirements.txt` to update by clicking on it in GitHub.
20
-
21
- <p align="center"><img width="800" alt="PR_step1" src="https://user-images.githubusercontent.com/26833433/122260847-08be2600-ced4-11eb-828b-8287ace4136c.png"></p>
22
-
23
- ### 2. Click 'Edit this file'
24
-
25
- Button is in top-right corner.
26
-
27
- <p align="center"><img width="800" alt="PR_step2" src="https://user-images.githubusercontent.com/26833433/122260844-06f46280-ced4-11eb-9eec-b8a24be519ca.png"></p>
28
-
29
- ### 3. Make Changes
30
-
31
- Change `matplotlib` version from `3.2.2` to `3.3`.
32
-
33
- <p align="center"><img width="800" alt="PR_step3" src="https://user-images.githubusercontent.com/26833433/122260853-0a87e980-ced4-11eb-9fd2-3650fb6e0842.png"></p>
34
-
35
- ### 4. Preview Changes and Submit PR
36
-
37
- 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 YOLOv8 for review and approval πŸ˜ƒ!
38
-
39
- <p align="center"><img width="800" alt="PR_step4" src="https://user-images.githubusercontent.com/26833433/122260856-0b208000-ced4-11eb-8e8e-77b6151cbcc3.png"></p>
40
-
41
- ### PR recommendations
42
-
43
- To allow your work to be integrated as seamlessly as possible, we advise you to:
44
-
45
- - βœ… Verify your PR is **up-to-date** with `ultralytics/ultralytics` `main` branch. If your PR is behind you can update your code by clicking the 'Update branch' button or by running `git pull` and `git merge main` locally.
46
-
47
- <p align="center"><img width="751" alt="PR recommendation 1" src="https://user-images.githubusercontent.com/26833433/187295893-50ed9f44-b2c9-4138-a614-de69bd1753d7.png"></p>
48
-
49
- - βœ… Verify all YOLOv8 Continuous Integration (CI) **checks are passing**.
50
-
51
- <p align="center"><img width="751" alt="PR recommendation 2" src="https://user-images.githubusercontent.com/26833433/187296922-545c5498-f64a-4d8c-8300-5fa764360da6.png"></p>
52
-
53
- - βœ… 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
54
-
55
- ### Docstrings
56
-
57
- Not all functions or classes require docstrings but when they do, we follow [google-style docstrings format](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings). Here is an example:
58
-
59
- ```python
60
- """
61
- What the function does. Performs NMS on given detection predictions.
62
-
63
- Args:
64
- arg1: The description of the 1st argument
65
- arg2: The description of the 2nd argument
66
-
67
- Returns:
68
- What the function returns. Empty if nothing is returned.
69
-
70
- Raises:
71
- Exception Class: When and why this exception can be raised by the function.
72
- """
73
- ```
74
-
75
- ## Submitting a Bug Report πŸ›
76
-
77
- If you spot a problem with YOLOv8 please submit a Bug Report!
78
-
79
- For us to start investigating a possible 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.
80
-
81
- 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://docs.ultralytics.com/help/minimum_reproducible_example/). Your code that reproduces the problem should be:
82
-
83
- - βœ… **Minimal** – Use as little code as possible that still produces the same problem
84
- - βœ… **Complete** – Provide **all** parts someone else needs to reproduce your problem in the question itself
85
- - βœ… **Reproducible** – Test the code you're about to provide to make sure it reproduces the problem
86
-
87
- In addition to the above requirements, for [Ultralytics](https://ultralytics.com/) to provide assistance your code should be:
88
-
89
- - βœ… **Current** – Verify that your code is up-to-date with current GitHub [main](https://github.com/ultralytics/ultralytics/tree/main) branch, and if necessary `git pull` or `git clone` a new copy to ensure your problem has not already been resolved by previous commits.
90
- - βœ… **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 ⚠️.
91
-
92
- 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/ultralytics/issues/new/choose) and providing a [minimum reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/) to help us better understand and diagnose your problem.
93
-
94
- ## License
95
-
96
- By contributing, you agree that your contributions will be licensed under the [AGPL-3.0 license](https://choosealicense.com/licenses/agpl-3.0/)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ReadMe.md DELETED
@@ -1,9 +0,0 @@
1
- ---
2
- title: mydemo1 # Replace with your app's title
3
- emoji: πŸš€ # Replace with an emoji for your app
4
- colorFrom: blue # Primary color of the UI
5
- colorTo: green # Secondary color of the UI
6
- sdk: docker # Since you're using Docker
7
- app_file: app.py # Main app file (this is still needed for display purposes, even if using Docker)
8
- pinned: false
9
- ---