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

Small fixes to docstrings #5313

Merged
merged 4 commits into from
Oct 24, 2021
Merged

Conversation

zhiqwang
Copy link
Contributor

@zhiqwang zhiqwang commented Oct 24, 2021

Hi @glenn-jocher

This PR does the following three things:

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Updated contributor guidance and automated welcome message in the YOLOv5 repository.

📊 Key Changes

  • Modified the GitHub greetings workflow to change the indentation of bash commands.
  • Updated the CONTRIBUTING.md documentation, adjusting the indentation of a bash command snippet and removing a quote from Bruce Lee.

🎯 Purpose & Impact

  • Ensure consistency and readability in documentation and automated messages, which benefits contributors when setting up their local environment for contributions.
  • The removal of the quote streamlines the contributing guidelines, focusing the content on technical instructions only. This may help in reducing distractions and making the document more focused and concise for contributors.

@glenn-jocher
Copy link
Member

@zhiqwang oh thanks for pointing out the discrepancy! Now that I look at it maybe it makes more sense to rename upstream to origin. In PyCharm it shows the remote github branches as origin. What do you think?
Screenshot 2021-10-24 at 12 59 03

@zhiqwang
Copy link
Contributor Author

zhiqwang commented Oct 24, 2021

Hi @glenn-jocher

Now that I look at it maybe it makes more sense to rename upstream to origin. In PyCharm it shows the remote github branches as origin. What do you think?

Seems to be origin only for you, because you have permission to work directly on https://github.com/ultralytics/yolov5, but for third party developers it is upstream, like for me, the origin I am currently working on is https://github.com/zhiqwang/yolov5 .

@glenn-jocher
Copy link
Member

@zhiqwang oh got it! origin is your fork, upstream is the repo that was forked. Yes you are right.

@glenn-jocher glenn-jocher merged commit 3d89798 into ultralytics:master Oct 24, 2021
@glenn-jocher
Copy link
Member

@zhiqwang PR is merged. Thank you for your contributions to YOLOv5 🚀 and Vision AI ⭐

@zhiqwang zhiqwang deleted the fix-docstrings branch October 25, 2021 01:50
BjarneKuehl pushed a commit to fhkiel-mlaip/yolov5 that referenced this pull request Aug 26, 2022
* Minor fixes of the git checkout new branch

* Use em dash to quote

* Revert the change of git checkout

* Maybe we should up-to-date with the upstream/master?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants