Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify README.md #3530

Merged
merged 36 commits into from
Jun 13, 2021
Merged
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
f6633ca
Update README.md
kalenmike Jun 8, 2021
4b1deb3
added hosted images
kalenmike Jun 8, 2021
d13652e
added new logo
kalenmike Jun 8, 2021
48b1aff
testing image hosting
kalenmike Jun 8, 2021
7d14359
changed svgs to pngs
kalenmike Jun 8, 2021
c3eedd5
removed old header
kalenmike Jun 8, 2021
958171a
Update README.md
glenn-jocher Jun 8, 2021
6492050
correct colab image source
kalenmike Jun 8, 2021
fdc7154
splash.jpg
glenn-jocher Jun 9, 2021
bfd5578
rocket and W&B fix
glenn-jocher Jun 10, 2021
1e699d0
added contributing template
kalenmike Jun 11, 2021
a3164da
added social media to top section
kalenmike Jun 11, 2021
c321a99
increased size of top social media
kalenmike Jun 11, 2021
f35bda3
cleanup and updates
glenn-jocher Jun 12, 2021
9ef5ee9
rearrange quickstarts
glenn-jocher Jun 12, 2021
724f827
API cleanup
glenn-jocher Jun 12, 2021
f6a7144
PyTorch Hub cleanup
glenn-jocher Jun 12, 2021
e63b574
Add tutorials
glenn-jocher Jun 12, 2021
ec6ddbe
cleanup
glenn-jocher Jun 12, 2021
0f27fbe
update CONTRIBUTING.md
glenn-jocher Jun 12, 2021
a270f7d
Update README.md
glenn-jocher Jun 12, 2021
3cfa58f
update wandb link
glenn-jocher Jun 12, 2021
8ee1461
Update README.md
glenn-jocher Jun 12, 2021
2cb6635
remove tutorials header
glenn-jocher Jun 12, 2021
32055e7
update environments and integrations
glenn-jocher Jun 12, 2021
dc323b5
Comment API image
glenn-jocher Jun 12, 2021
42f898d
Update README.md
glenn-jocher Jun 12, 2021
1766dfc
Update README.md
glenn-jocher Jun 12, 2021
e059d1c
Update README.md
glenn-jocher Jun 12, 2021
591c4fe
Update README.md
glenn-jocher Jun 12, 2021
4de5012
Update README.md
glenn-jocher Jun 12, 2021
ad8a50f
double spaces after section
glenn-jocher Jun 12, 2021
5b429f8
Merge remote-tracking branch 'origin/KalenMike-readme-update' into Ka…
glenn-jocher Jun 12, 2021
90b71ca
Merge branch 'master' into KalenMike-readme-update
glenn-jocher Jun 12, 2021
7f04ca0
Update README.md
glenn-jocher Jun 12, 2021
cdf62c2
Update README.md
glenn-jocher Jun 12, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update CONTRIBUTING.md
  • Loading branch information
glenn-jocher committed Jun 12, 2021
commit 0f27fbe9d71b6f94675e7ee6f6eed2d5e5e94181
65 changes: 30 additions & 35 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,49 @@
# Contributing to Transcriptase
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
## Contributing to YOLOv5 πŸš€

We love your input! We want to make contributing to YOLOv5 as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Proposing a new feature
- Becoming a maintainer

## We Develop with Github
We use github to host code, to track issues and feature requests, as well as accept pull requests.
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 πŸ˜ƒ!


## Submitting a Pull Request (PR) πŸ› οΈ

## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
To allow your work to be integrated as seamlessly as possible, we advise you to:
- βœ… 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:
```bash
git remote add upstream https://github.com/ultralytics/yolov5.git
git fetch upstream
git checkout feature # <----- replace 'feature' with local branch name
git merge upstream/master
git push -u origin -f
```
- βœ… Verify all Continuous Integration (CI) **checks are passing**.
- βœ… 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

1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
## Submitting a Bug Report πŸ›

## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
For us to investigate an issue we would 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 investigating a possible problem.

## Write bug reports with detail, background, and sample code
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
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:

**Great Bug Reports** tend to have:
* βœ… **Minimal** – Use as little code as possible that still produces the same problem
* βœ… **Complete** – Provide **all** parts someone else needs to reproduce your problem in the question itself
* βœ… **Reproducible** – Test the code you're about to provide to make sure it reproduces the problem

- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
In addition to the above requirements, for [Ultralytics](https://ultralytics.com/) to provide assistance your code should be:

People *love* thorough bug reports. I'm not even kidding.
* βœ… **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.
* βœ… **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 ⚠️.

## Use a Consistent Coding Style
I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
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.

* 2 spaces for indentation rather than tabs
* You can try running `npm run lint` for style unification

## License
By contributing, you agree that your contributions will be licensed under its MIT License.

## References
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
By contributing, you agree that your contributions will be licensed under the [GPL-3.0 license](https://choosealicense.com/licenses/gpl-3.0/)