Skip to content

Commit

Permalink
Deployed c80e5bc with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@UltralyticsAssistant
UltralyticsAssistant committed Jan 15, 2025
1 parent dd0cbde commit edec8b6
Show file tree
Hide file tree
Showing 3 changed files with 208 additions and 74 deletions.
238 changes: 186 additions & 52 deletions contributions/how-to-contribute/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8"/>
<meta content="width=device-width,initial-scale=1" name="viewport"/>
<meta content="Explore the Ultralytics Handbook—a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource." name="description"/>
<meta content="Learn how to contribute to Ultralytics open-source projects and connect with our development team. Follow our guidelines to make meaningful contributions to our AI ecosystem." name="description"/>
<meta content="Ultralytics" name="author"/>
<link href="https://handbook.ultralytics.com/contributions/how-to-contribute/" rel="canonical"/>
<link href="../../workflows/documentation/" rel="prev"/>
Expand All @@ -20,7 +20,7 @@
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link href="../../stylesheets/style.css" rel="stylesheet"/>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta content="How to Contribute" name="title"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/all.min.css" rel="stylesheet"/><meta content="Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines" name="keywords"/><meta content="website" property="og:type"/><meta content="https://handbook.ultralytics.com/contributions/how-to-contribute" property="og:url"/><meta content="How to Contribute" property="og:title"/><meta content="Explore the Ultralytics Handbook—a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource." property="og:description"/><meta content="https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png" property="og:image"/><meta content="summary_large_image" property="twitter:card"/><meta content="https://handbook.ultralytics.com/contributions/how-to-contribute" property="twitter:url"/><meta content="How to Contribute" property="twitter:title"/><meta content="Explore the Ultralytics Handbook—a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource." property="twitter:description"/><meta content="https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png" property="twitter:image"/><script type="application/ld+json">{"@context": "https://schema.org", "@type": "Article", "headline": "How to Contribute", "image": ["https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png"], "datePublished": "2024-10-13 22:11:52 +0200", "dateModified": "2024-10-14 03:20:52 +0200", "author": [{"@type": "Organization", "name": "Ultralytics", "url": "https://ultralytics.com/"}], "abstract": "Explore the Ultralytics Handbook\u2014a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource."}</script></head>
<meta content="How to Contribute" name="title"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/all.min.css" rel="stylesheet"/><meta content="Ultralytics, open source, contribution guidelines, GitHub, development team, AI, machine learning, collaboration" name="keywords"/><meta content="website" property="og:type"/><meta content="https://handbook.ultralytics.com/contributions/how-to-contribute" property="og:url"/><meta content="How to Contribute" property="og:title"/><meta content="Learn how to contribute to Ultralytics open-source projects and connect with our development team. Follow our guidelines to make meaningful contributions to our AI ecosystem." property="og:description"/><meta content="https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png" property="og:image"/><meta content="summary_large_image" property="twitter:card"/><meta content="https://handbook.ultralytics.com/contributions/how-to-contribute" property="twitter:url"/><meta content="How to Contribute" property="twitter:title"/><meta content="Learn how to contribute to Ultralytics open-source projects and connect with our development team. Follow our guidelines to make meaningful contributions to our AI ecosystem." property="twitter:description"/><meta content="https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png" property="twitter:image"/><script type="application/ld+json">{"@context": "https://schema.org", "@type": "Article", "headline": "How to Contribute", "image": ["https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png"], "datePublished": "2024-10-13 22:11:52 +0200", "dateModified": "2025-01-15 13:21:13 +0100", "author": [{"@type": "Organization", "name": "Ultralytics", "url": "https://ultralytics.com/"}], "abstract": "Learn how to contribute to Ultralytics open-source projects and connect with our development team. Follow our guidelines to make meaningful contributions to our AI ecosystem."}</script></head>
<body data-md-color-accent="indigo" data-md-color-primary="indigo" data-md-color-scheme="default" dir="ltr">
<input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
<input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
Expand Down Expand Up @@ -311,37 +311,30 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#handbook-under-construction">
<a class="md-nav__link" href="#our-development-team">
<span class="md-ellipsis">
Handbook Under Construction 🏗️📖
Our Development Team
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#what-to-expect-from-the-handbook">
<a class="md-nav__link" href="#contribution-guidelines">
<span class="md-ellipsis">
What to Expect from the Handbook 📘
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#stay-informed">
<a class="md-nav__link" href="#get-involved">
<span class="md-ellipsis">
Stay Informed 🚧
Get Involved
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#be-a-part-of-the-handbook">
<a class="md-nav__link" href="#questions-and-support">
<span class="md-ellipsis">
Be a Part of the Handbook 🗣️
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#thank-you-to-our-community">
<span class="md-ellipsis">
Thank You to Our Community 🌍
Questions and Support
</span>
</a>
</li>
Expand Down Expand Up @@ -405,37 +398,30 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#handbook-under-construction">
<span class="md-ellipsis">
Handbook Under Construction 🏗️📖
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#what-to-expect-from-the-handbook">
<a class="md-nav__link" href="#our-development-team">
<span class="md-ellipsis">
What to Expect from the Handbook 📘
Our Development Team
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#stay-informed">
<a class="md-nav__link" href="#contribution-guidelines">
<span class="md-ellipsis">
Stay Informed 🚧
Contribution Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#be-a-part-of-the-handbook">
<a class="md-nav__link" href="#get-involved">
<span class="md-ellipsis">
Be a Part of the Handbook 🗣️
Get Involved
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#thank-you-to-our-community">
<a class="md-nav__link" href="#questions-and-support">
<span class="md-ellipsis">
Thank You to Our Community 🌍
Questions and Support
</span>
</a>
</li>
Expand All @@ -450,38 +436,186 @@
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"></path></svg>
</a>
<h1 id="how-to-contribute">How to Contribute</h1>
<h2 id="handbook-under-construction">Handbook Under Construction 🏗️📖</h2>
<p>Welcome to the <a href="https://www.ultralytics.com/">Ultralytics</a> <a href="https://handbook.ultralytics.com/">Handbook</a> "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available.</p>
<h2 id="what-to-expect-from-the-handbook">What to Expect from the Handbook 📘</h2>
<p>Welcome to the Ultralytics contribution guide! We're excited to have you join our community of developers and researchers working to advance AI technology. This guide will help you understand how to contribute effectively to our projects.</p>
<h2 id="our-development-team">Our Development Team</h2>
<p>Our open-source projects are maintained by a dedicated team of developers. Feel free to reach out to team members for guidance:</p>
<table>
<thead>
<tr>
<th>Employee Name</th>
<th>GitHub Profile</th>
</tr>
</thead>
<tbody>
<tr>
<td>Paula Derrenger</td>
<td><a href="https://github.com/pderrenger">pderrenger</a></td>
</tr>
<tr>
<td>Muhammad Rizwan Munawar</td>
<td><a href="https://github.com/RizwanMunawar">RizwanMunawar</a></td>
</tr>
<tr>
<td>Sergiu Waxmann</td>
<td><a href="https://github.com/sergiuwaxmann">sergiuwaxmann</a></td>
</tr>
<tr>
<td>Kirill Viarbitski</td>
<td><a href="https://github.com/Kverbitski">Kverbitski</a></td>
</tr>
<tr>
<td>Fatih Akyon</td>
<td><a href="https://github.com/fcakyon">fcakyon</a></td>
</tr>
<tr>
<td>Abrish Sabri</td>
<td><a href="https://github.com/asabri97">asabri97</a></td>
</tr>
<tr>
<td>Yogendra Singh</td>
<td><a href="https://github.com/yogendrasinghx">yogendrasinghx</a></td>
</tr>
<tr>
<td>Lakshantha Dissanayake</td>
<td><a href="https://github.com/lakshanthad">lakshanthad</a></td>
</tr>
<tr>
<td>Giovanni DZ</td>
<td><a href="https://github.com/ggg-dz-ultralytics">ggg-dz-ultralytics</a></td>
</tr>
<tr>
<td>Jing Qiu</td>
<td><a href="https://github.com/Laughing-q">Laughing-q</a></td>
</tr>
<tr>
<td>Burhan Qaddoumi</td>
<td><a href="https://github.com/Burhan-Q">Burhan-Q</a></td>
</tr>
<tr>
<td>Thomas Chuang</td>
<td><a href="https://github.com/chuang091">chuang091</a></td>
</tr>
<tr>
<td>Pablo Karnbaum</td>
<td><a href="https://github.com/pablokarnbaum">pablokarnbaum</a></td>
</tr>
<tr>
<td>Amir Roshanaei</td>
<td><a href="https://github.com/bitcodr">bitcodr</a></td>
</tr>
<tr>
<td>Glenn Jocher</td>
<td><a href="https://github.com/glenn-jocher">glenn-jocher</a></td>
</tr>
<tr>
<td>Francesco Mattioli</td>
<td><a href="https://github.com/ambitious-octopus">ambitious-octopus</a></td>
</tr>
<tr>
<td>Olga Krupskaia</td>
<td><a href="https://github.com/Krupskaya">Krupskaya</a></td>
</tr>
<tr>
<td>Jose Bondi</td>
<td><a href="https://github.com/joseUltra">joseUltra</a></td>
</tr>
<tr>
<td>Abirami Vina</td>
<td><a href="https://github.com/abirami-vina">abirami-vina</a></td>
</tr>
<tr>
<td>Nathan Yan</td>
<td><a href="https://github.com/CodCodingCode">CodCodingCode</a></td>
</tr>
<tr>
<td>Hannah Streif</td>
<td><a href="https://github.com/HannahStreif">HannahStreif</a></td>
</tr>
<tr>
<td>William Beaven</td>
<td><a href="https://github.com/william-beaven">william-beaven</a></td>
</tr>
<tr>
<td>Abdelrahman Elgendy</td>
<td><a href="https://github.com/AbdelrahmanEL-gendy">AbdelrahmanEL-gendy</a></td>
</tr>
<tr>
<td>Nuvola Ladi</td>
<td><a href="https://github.com/NLadi">NLadi</a></td>
</tr>
<tr>
<td>Hans van de Broek</td>
<td><a href="https://github.com/barnahans">barnahans</a></td>
</tr>
<tr>
<td>Ivor Zhu</td>
<td><a href="https://github.com/IvorZhu331">IvorZhu331</a></td>
</tr>
<tr>
<td>Marius Keiser</td>
<td><a href="https://github.com/Skillnoob">Skillnoob</a></td>
</tr>
<tr>
<td>Mohammed Yasin</td>
<td><a href="https://github.com/Y-T-G">Y-T-G</a></td>
</tr>
<tr>
<td>Tasha Anthony</td>
<td><a href="https://github.com/recruiter2002">recruiter2002</a></td>
</tr>
<tr>
<td>Alexis Barou</td>
<td><a href="https://github.com/LexBarou">LexBarou</a></td>
</tr>
<tr>
<td>Nicolai Nielsen</td>
<td><a href="https://github.com/niconielsen32">niconielsen32</a></td>
</tr>
<tr>
<td>Joey Tjon</td>
<td><a href="https://github.com/NoCodeJoey">NoCodeJoey</a></td>
</tr>
</tbody>
</table>
<h2 id="contribution-guidelines">Contribution Guidelines</h2>
<p>For detailed contribution guidelines, please visit our <a href="https://docs.ultralytics.com/help/contribute">official documentation</a>. Here's a quick overview of the process:</p>
<ol>
<li>Fork the repository you want to contribute to</li>
<li>Create a new branch for your feature or fix</li>
<li>Follow our coding standards and documentation requirements</li>
<li>Submit a pull request with a clear description of your changes</li>
<li>Engage with reviewers and address any feedback</li>
</ol>
<h2 id="get-involved">Get Involved</h2>
<p>There are many ways to contribute to Ultralytics:</p>
<ul>
<li><strong>Mission and Values:</strong> Learn what drives Ultralytics forward and how we aim to make a lasting impact.</li>
<li><strong>Operational Workflows:</strong> Discover how we work internally, including development processes, team collaboration, and continuous improvement.</li>
<li><strong>Contribution Guidelines:</strong> Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community.</li>
<li>Code contributions via pull requests</li>
<li>Documentation improvements</li>
<li>Bug reports and feature requests</li>
<li>Community support and discussions</li>
<li>Testing and feedback on new features</li>
</ul>
<h2 id="stay-informed">Stay Informed 🚧</h2>
<p>This placeholder page is just the start. Soon, you’ll have access to:</p>
<p>We welcome contributions from developers of all experience levels. If you're new to open source, our team members are here to help guide you through your first contribution.</p>
<h2 id="questions-and-support">Questions and Support</h2>
<p>If you have questions about contributing, you can:</p>
<ul>
<li><strong>Internal Workflows:</strong> Best practices for development, testing, and open-source contributions.</li>
<li><strong>Team Roles:</strong> Detailed roles and responsibilities for team members and contributors.</li>
<li><strong>Collaboration Guidelines:</strong> Clear guidance for collaborating on projects and contributing effectively.</li>
<li>Open an issue on GitHub</li>
<li>Join our community discussions</li>
<li>Reach out to team members listed above</li>
<li>Check our <a href="https://docs.ultralytics.com">documentation</a> for guides and tutorials</li>
</ul>
<h2 id="be-a-part-of-the-handbook">Be a Part of the Handbook 🗣️</h2>
<p>We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts <a href="https://www.ultralytics.com/survey">here</a>.</p>
<h2 id="thank-you-to-our-community">Thank You to Our Community 🌍</h2>
<p>Your <a href="https://docs.ultralytics.com/help/contributing/">contributions</a> and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values.</p>
<hr/>
<p>Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! 📖✨</p>
<p>Thank you for your interest in contributing to Ultralytics! Together, we're building the future of AI technology.</p>
<div class="git-info">
<div class="dates-container">
<span class="date-item" title="This page was first created on October 13, 2024">
<span class="hover-item">📅</span> Created 3 months ago
</span>
<span class="date-item" title="This page was last updated on October 14, 2024">
<span class="hover-item">✏️</span> Updated 3 months ago
<span class="date-item" title="This page was last updated on January 15, 2025">
<span class="hover-item">✏️</span> Updated 0 days ago
</span>
</div>
<div class="authors-container">
<a class="author-link" href="https://github.com/glenn-jocher" title="glenn-jocher (2 changes)">
<a class="author-link" href="https://github.com/glenn-jocher" title="glenn-jocher (3 changes)">
<img alt="glenn-jocher" class="hover-item" loading="lazy" src="https://avatars.githubusercontent.com/u/26833433?v=4&amp;s=96"/>
</a>
</div></div><div class="share-buttons">
Expand Down
Loading

0 comments on commit edec8b6

Please sign in to comment.