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

Add mdformat to precommit checks and update other version #7529

Merged
merged 10 commits into from
Apr 22, 2022

Conversation

Zengyf-CVer
Copy link
Contributor

@Zengyf-CVer Zengyf-CVer commented Apr 22, 2022

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

This PR provides updates to the code of conduct, pre-commit hooks, contribution guidelines, and documentation, including improvements and new features for integration with Weights & Biases.

📊 Key Changes

  • Updated the .github/CODE_OF_CONDUCT.md, enhancing community behavior guidelines.
  • Upgraded pre-commit hooks to newer versions and added Markdown formatting hooks.
  • Enriched CONTRIBUTING.md with additional visuals and clarified PR submission process.
  • Streamlined and updated README.md documentation including tutorial links and tables.
  • Enhanced the Weights & Biases logger integration within the utils/loggers/wandb/README.md to provide detailed instructions and usage examples for advanced features like dataset versioning, evaluation, and checkpoint saving.

🎯 Purpose & Impact

  • Code of Conduct Updates: Foster a more welcoming and inclusive community environment. 🤗
  • Pre-commit Hook Enhancements: Ensure higher code quality and consistency in the repository. 🎨
  • Contribution Documentation Amendments: Simplify the process for new contributors to propose changes, promoting community involvement. 👨‍💻👩‍💻
  • Documentation Streamlining: Provide a cleaner and more informative landing page for users and developers, improving the user experience and ease of access to information. 📖
  • Weights & Biases Integration Enhancements: Offer in-depth guidance for advanced model tracking and workflow management, benefiting users who utilize Weights & Biases for experiment tracking and model tuning. 🔬🧪

These updates are aimed at improving user experience and developer workflows, as well as reinforcing community standards.

@glenn-jocher
Copy link
Member

@Zengyf-CVer thanks for the PR! I'd worked with @Borda on this previously, but I got hung up on two yolov5/README changes. Do you guys know if there's simply a way to exclude individual files (or sections in a README) from the formatter?

Screen Shot 2022-04-22 at 10 19 10 AM

Screen Shot 2022-04-22 at 10 19 31 AM

@Borda
Copy link
Contributor

Borda commented Apr 22, 2022

Do you guys know if there's simply a way to exclude individual files (or sections in a README) from the formatter?

yes, you can exclude files, see https://github.com/PyTorchLightning/metrics/blob/f8ef656efc022e0c2199811e1b3bd490bd0ba61d/.pre-commit-config.yaml#L74-L78

@glenn-jocher glenn-jocher merged commit c264795 into ultralytics:master Apr 22, 2022
@glenn-jocher
Copy link
Member

@Zengyf-CVer @Borda PR is merged. All Pre-Commit checks are in place now!! 🚀🚀🚀

Thank you for your contributions to YOLOv5 🚀 and Vision AI ⭐

BjarneKuehl pushed a commit to fhkiel-mlaip/yolov5 that referenced this pull request Aug 26, 2022
…s#7529)

* Update .pre-commit-config.yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update .pre-commit-config.yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update CONTRIBUTING.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
ctjanuhowski pushed a commit to ctjanuhowski/yolov5 that referenced this pull request Sep 8, 2022
…s#7529)

* Update .pre-commit-config.yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update .pre-commit-config.yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update CONTRIBUTING.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
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.

None yet

3 participants