From adf162c9dc7f14617d19f06c86cd82d69d52490d Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Wed, 15 Jan 2025 13:06:37 +0100 Subject: [PATCH 1/9] Add GitHub usernames Signed-off-by: Glenn Jocher --- docs/contributions/how-to-contribute.md | 81 +++++++++++++++++++------ 1 file changed, 62 insertions(+), 19 deletions(-) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 84d0290..4f5bb3f 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -1,36 +1,79 @@ --- -description: 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. -keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +description: 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. +keywords: Ultralytics, open source, contribution guidelines, GitHub, development team, AI, machine learning, collaboration --- # How to Contribute -## Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– +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. -Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "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. +## Our Development Team -## What to Expect from the Handbook ๐Ÿ“˜ +Our open-source projects are maintained by a dedicated team of developers. Feel free to reach out to team members for guidance: -- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. -- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. -- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. +| Employee Name | GitHub Profile | +|--------------|----------------| +| Paula Derrenger | [pderrenger](https://github.com/pderrenger) | +| Muhammad Rizwan Munawar | [RizwanMunawar](https://github.com/RizwanMunawar) | +| Wax | [sergiuwaxmann](https://github.com/sergiuwaxmann) | +| Kirill | [Kverbitski](https://github.com/Kverbitski) | +| Fatih Akyon | [fcakyon](https://github.com/fcakyon) | +| Abrish | [asabri97](https://github.com/asabri97) | +| Yogendra Singh | [yogendrasinghx](https://github.com/yogendrasinghx) | +| Lakshantha Dissanayake | [lakshanthad](https://github.com/lakshanthad) | +| Giovanni DZ | [ggg-dz-ultralytics](https://github.com/ggg-dz-ultralytics) | +| Jing Qiu | [Laughing-q](https://github.com/Laughing-q) | +| Burhan Qaddoumi | [Burhan-Q](https://github.com/Burhan-Q) | +| Thomas | [chuang091](https://github.com/chuang091) | +| Pablo Karnbaum | [pablokarnbaum](https://github.com/pablokarnbaum) | +| Amir Roshanaei | [bitcodr](https://github.com/bitcodr) | +| Glenn Jocher | [glenn-jocher](https://github.com/glenn-jocher) | +| Francesco Mattioli | [ambitious-octopus](https://github.com/ambitious-octopus) | +| Olga Krupskaia | [Krupskaya](https://github.com/Krupskaya) | +| Jose Bondi | [joseUltra](https://github.com/joseUltra) | +| Abirami Vina | [abirami-vina](https://github.com/abirami-vina) | +| Nathan Yan | [CodCodingCode](https://github.com/CodCodingCode) | +| Hannah Streif | [HannahStreif](https://github.com/HannahStreif) | +| William Beaven | [william-beaven](https://github.com/william-beaven) | +| Abdelrahman Elgendy | [AbdelrahmanEL-gendy](https://github.com/AbdelrahmanEL-gendy) | +| Nuvola Ladi | [NLadi](https://github.com/NLadi) | +| Hans | [barnahans](https://github.com/barnahans) | +| Ivor Zhu | [IvorZhu331](https://github.com/IvorZhu331) | +| Marius | [Skillnoob](https://github.com/Skillnoob) | +| Mohammed Yasin | [Y-T-G](https://github.com/Y-T-G) | +| Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | +| Alexis Barou | [LexBarou](https://github.com/LexBarou) | +| Nicolai Nielsen | [niconielsen32](https://github.com/niconielsen32) | -## Stay Informed ๐Ÿšง +## Contribution Guidelines -This placeholder page is just the start. Soon, youโ€™ll have access to: +For detailed contribution guidelines, please visit our [official documentation](https://docs.ultralytics.com/help/contribute). Here's a quick overview of the process: -- **Internal Workflows:** Best practices for development, testing, and open-source contributions. -- **Team Roles:** Detailed roles and responsibilities for team members and contributors. -- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. +1. Fork the repository you want to contribute to +2. Create a new branch for your feature or fix +3. Follow our coding standards and documentation requirements +4. Submit a pull request with a clear description of your changes +5. Engage with reviewers and address any feedback -## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ +## Get Involved -We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). +There are many ways to contribute to Ultralytics: -## Thank You to Our Community ๐ŸŒ +- Code contributions via pull requests +- Documentation improvements +- Bug reports and feature requests +- Community support and discussions +- Testing and feedback on new features -Your [contributions](https://docs.ultralytics.com/help/contributing/) 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. +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. ---- +## Questions and Support + +If you have questions about contributing, you can: + +- Open an issue on GitHub +- Join our community discussions +- Reach out to team members listed above +- Check our [documentation](https://docs.ultralytics.com) for guides and tutorials -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! ๐Ÿ“–โœจ +Thank you for your interest in contributing to Ultralytics! Together, we're building the future of AI technology. From 212bb42a3819bad31c9bc96e9bf2a7fff4c045c6 Mon Sep 17 00:00:00 2001 From: UltralyticsAssistant Date: Wed, 15 Jan 2025 12:07:11 +0000 Subject: [PATCH 2/9] Auto-format by https://ultralytics.com/actions --- docs/contributions/how-to-contribute.md | 66 ++++++++++++------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 4f5bb3f..183ab5b 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -11,39 +11,39 @@ Welcome to the Ultralytics contribution guide! We're excited to have you join ou Our open-source projects are maintained by a dedicated team of developers. Feel free to reach out to team members for guidance: -| Employee Name | GitHub Profile | -|--------------|----------------| -| Paula Derrenger | [pderrenger](https://github.com/pderrenger) | -| Muhammad Rizwan Munawar | [RizwanMunawar](https://github.com/RizwanMunawar) | -| Wax | [sergiuwaxmann](https://github.com/sergiuwaxmann) | -| Kirill | [Kverbitski](https://github.com/Kverbitski) | -| Fatih Akyon | [fcakyon](https://github.com/fcakyon) | -| Abrish | [asabri97](https://github.com/asabri97) | -| Yogendra Singh | [yogendrasinghx](https://github.com/yogendrasinghx) | -| Lakshantha Dissanayake | [lakshanthad](https://github.com/lakshanthad) | -| Giovanni DZ | [ggg-dz-ultralytics](https://github.com/ggg-dz-ultralytics) | -| Jing Qiu | [Laughing-q](https://github.com/Laughing-q) | -| Burhan Qaddoumi | [Burhan-Q](https://github.com/Burhan-Q) | -| Thomas | [chuang091](https://github.com/chuang091) | -| Pablo Karnbaum | [pablokarnbaum](https://github.com/pablokarnbaum) | -| Amir Roshanaei | [bitcodr](https://github.com/bitcodr) | -| Glenn Jocher | [glenn-jocher](https://github.com/glenn-jocher) | -| Francesco Mattioli | [ambitious-octopus](https://github.com/ambitious-octopus) | -| Olga Krupskaia | [Krupskaya](https://github.com/Krupskaya) | -| Jose Bondi | [joseUltra](https://github.com/joseUltra) | -| Abirami Vina | [abirami-vina](https://github.com/abirami-vina) | -| Nathan Yan | [CodCodingCode](https://github.com/CodCodingCode) | -| Hannah Streif | [HannahStreif](https://github.com/HannahStreif) | -| William Beaven | [william-beaven](https://github.com/william-beaven) | -| Abdelrahman Elgendy | [AbdelrahmanEL-gendy](https://github.com/AbdelrahmanEL-gendy) | -| Nuvola Ladi | [NLadi](https://github.com/NLadi) | -| Hans | [barnahans](https://github.com/barnahans) | -| Ivor Zhu | [IvorZhu331](https://github.com/IvorZhu331) | -| Marius | [Skillnoob](https://github.com/Skillnoob) | -| Mohammed Yasin | [Y-T-G](https://github.com/Y-T-G) | -| Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | -| Alexis Barou | [LexBarou](https://github.com/LexBarou) | -| Nicolai Nielsen | [niconielsen32](https://github.com/niconielsen32) | +| Employee Name | GitHub Profile | +| ----------------------- | ------------------------------------------------------------- | +| Paula Derrenger | [pderrenger](https://github.com/pderrenger) | +| Muhammad Rizwan Munawar | [RizwanMunawar](https://github.com/RizwanMunawar) | +| Wax | [sergiuwaxmann](https://github.com/sergiuwaxmann) | +| Kirill | [Kverbitski](https://github.com/Kverbitski) | +| Fatih Akyon | [fcakyon](https://github.com/fcakyon) | +| Abrish | [asabri97](https://github.com/asabri97) | +| Yogendra Singh | [yogendrasinghx](https://github.com/yogendrasinghx) | +| Lakshantha Dissanayake | [lakshanthad](https://github.com/lakshanthad) | +| Giovanni DZ | [ggg-dz-ultralytics](https://github.com/ggg-dz-ultralytics) | +| Jing Qiu | [Laughing-q](https://github.com/Laughing-q) | +| Burhan Qaddoumi | [Burhan-Q](https://github.com/Burhan-Q) | +| Thomas | [chuang091](https://github.com/chuang091) | +| Pablo Karnbaum | [pablokarnbaum](https://github.com/pablokarnbaum) | +| Amir Roshanaei | [bitcodr](https://github.com/bitcodr) | +| Glenn Jocher | [glenn-jocher](https://github.com/glenn-jocher) | +| Francesco Mattioli | [ambitious-octopus](https://github.com/ambitious-octopus) | +| Olga Krupskaia | [Krupskaya](https://github.com/Krupskaya) | +| Jose Bondi | [joseUltra](https://github.com/joseUltra) | +| Abirami Vina | [abirami-vina](https://github.com/abirami-vina) | +| Nathan Yan | [CodCodingCode](https://github.com/CodCodingCode) | +| Hannah Streif | [HannahStreif](https://github.com/HannahStreif) | +| William Beaven | [william-beaven](https://github.com/william-beaven) | +| Abdelrahman Elgendy | [AbdelrahmanEL-gendy](https://github.com/AbdelrahmanEL-gendy) | +| Nuvola Ladi | [NLadi](https://github.com/NLadi) | +| Hans | [barnahans](https://github.com/barnahans) | +| Ivor Zhu | [IvorZhu331](https://github.com/IvorZhu331) | +| Marius | [Skillnoob](https://github.com/Skillnoob) | +| Mohammed Yasin | [Y-T-G](https://github.com/Y-T-G) | +| Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | +| Alexis Barou | [LexBarou](https://github.com/LexBarou) | +| Nicolai Nielsen | [niconielsen32](https://github.com/niconielsen32) | ## Contribution Guidelines From b0c10fb42201abf139bb208a0e0c13d8325a902e Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Wed, 15 Jan 2025 13:07:24 +0100 Subject: [PATCH 3/9] Update how-to-contribute.md Signed-off-by: Glenn Jocher --- docs/contributions/how-to-contribute.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 183ab5b..1881f8f 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -44,6 +44,7 @@ Our open-source projects are maintained by a dedicated team of developers. Feel | Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | | Alexis Barou | [LexBarou](https://github.com/LexBarou) | | Nicolai Nielsen | [niconielsen32](https://github.com/niconielsen32) | +| Joey Tjon | - | ## Contribution Guidelines From 949e47db564b1d51412d188d3cce5b18b7fd3d21 Mon Sep 17 00:00:00 2001 From: UltralyticsAssistant Date: Wed, 15 Jan 2025 12:07:35 +0000 Subject: [PATCH 4/9] Auto-format by https://ultralytics.com/actions --- docs/contributions/how-to-contribute.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 1881f8f..1f7fe48 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -44,7 +44,7 @@ Our open-source projects are maintained by a dedicated team of developers. Feel | Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | | Alexis Barou | [LexBarou](https://github.com/LexBarou) | | Nicolai Nielsen | [niconielsen32](https://github.com/niconielsen32) | -| Joey Tjon | - | +| Joey Tjon | - | ## Contribution Guidelines From 8f17bc7757d052ca63f764c5b1272f7da4b2551a Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Wed, 15 Jan 2025 13:09:51 +0100 Subject: [PATCH 5/9] Update how-to-contribute.md Signed-off-by: Glenn Jocher --- docs/contributions/how-to-contribute.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 1f7fe48..9d8539a 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -15,7 +15,7 @@ Our open-source projects are maintained by a dedicated team of developers. Feel | ----------------------- | ------------------------------------------------------------- | | Paula Derrenger | [pderrenger](https://github.com/pderrenger) | | Muhammad Rizwan Munawar | [RizwanMunawar](https://github.com/RizwanMunawar) | -| Wax | [sergiuwaxmann](https://github.com/sergiuwaxmann) | +| Sergiu Waxmann | [sergiuwaxmann](https://github.com/sergiuwaxmann) | | Kirill | [Kverbitski](https://github.com/Kverbitski) | | Fatih Akyon | [fcakyon](https://github.com/fcakyon) | | Abrish | [asabri97](https://github.com/asabri97) | From 5757a4e7e4f816a70f96f2da049917c40036906f Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Wed, 15 Jan 2025 13:12:51 +0100 Subject: [PATCH 6/9] Update how-to-contribute.md Signed-off-by: Glenn Jocher --- docs/contributions/how-to-contribute.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 9d8539a..1cd96d4 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -16,15 +16,15 @@ Our open-source projects are maintained by a dedicated team of developers. Feel | Paula Derrenger | [pderrenger](https://github.com/pderrenger) | | Muhammad Rizwan Munawar | [RizwanMunawar](https://github.com/RizwanMunawar) | | Sergiu Waxmann | [sergiuwaxmann](https://github.com/sergiuwaxmann) | -| Kirill | [Kverbitski](https://github.com/Kverbitski) | +| Kirill Viarbitski | [Kverbitski](https://github.com/Kverbitski) | | Fatih Akyon | [fcakyon](https://github.com/fcakyon) | -| Abrish | [asabri97](https://github.com/asabri97) | +| Abrish Sabri | [asabri97](https://github.com/asabri97) | | Yogendra Singh | [yogendrasinghx](https://github.com/yogendrasinghx) | | Lakshantha Dissanayake | [lakshanthad](https://github.com/lakshanthad) | | Giovanni DZ | [ggg-dz-ultralytics](https://github.com/ggg-dz-ultralytics) | | Jing Qiu | [Laughing-q](https://github.com/Laughing-q) | | Burhan Qaddoumi | [Burhan-Q](https://github.com/Burhan-Q) | -| Thomas | [chuang091](https://github.com/chuang091) | +| Thomas Chuang | [chuang091](https://github.com/chuang091) | | Pablo Karnbaum | [pablokarnbaum](https://github.com/pablokarnbaum) | | Amir Roshanaei | [bitcodr](https://github.com/bitcodr) | | Glenn Jocher | [glenn-jocher](https://github.com/glenn-jocher) | @@ -37,9 +37,9 @@ Our open-source projects are maintained by a dedicated team of developers. Feel | William Beaven | [william-beaven](https://github.com/william-beaven) | | Abdelrahman Elgendy | [AbdelrahmanEL-gendy](https://github.com/AbdelrahmanEL-gendy) | | Nuvola Ladi | [NLadi](https://github.com/NLadi) | -| Hans | [barnahans](https://github.com/barnahans) | +| Hans van de Broek | [barnahans](https://github.com/barnahans) | | Ivor Zhu | [IvorZhu331](https://github.com/IvorZhu331) | -| Marius | [Skillnoob](https://github.com/Skillnoob) | +| Marius Keiser | [Skillnoob](https://github.com/Skillnoob) | | Mohammed Yasin | [Y-T-G](https://github.com/Y-T-G) | | Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | | Alexis Barou | [LexBarou](https://github.com/LexBarou) | From c7b7e61091e2f011200afd70bcd661305fcbd9d9 Mon Sep 17 00:00:00 2001 From: UltralyticsAssistant Date: Wed, 15 Jan 2025 12:13:14 +0000 Subject: [PATCH 7/9] Auto-format by https://ultralytics.com/actions --- docs/contributions/how-to-contribute.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 1cd96d4..35c9a6b 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -37,9 +37,9 @@ Our open-source projects are maintained by a dedicated team of developers. Feel | William Beaven | [william-beaven](https://github.com/william-beaven) | | Abdelrahman Elgendy | [AbdelrahmanEL-gendy](https://github.com/AbdelrahmanEL-gendy) | | Nuvola Ladi | [NLadi](https://github.com/NLadi) | -| Hans van de Broek | [barnahans](https://github.com/barnahans) | +| Hans van de Broek | [barnahans](https://github.com/barnahans) | | Ivor Zhu | [IvorZhu331](https://github.com/IvorZhu331) | -| Marius Keiser | [Skillnoob](https://github.com/Skillnoob) | +| Marius Keiser | [Skillnoob](https://github.com/Skillnoob) | | Mohammed Yasin | [Y-T-G](https://github.com/Y-T-G) | | Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | | Alexis Barou | [LexBarou](https://github.com/LexBarou) | From 9ae68955f38d5eca995a60aeeb43cff168350871 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Wed, 15 Jan 2025 13:20:14 +0100 Subject: [PATCH 8/9] Update how-to-contribute.md Signed-off-by: Glenn Jocher --- docs/contributions/how-to-contribute.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 35c9a6b..9079579 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -44,7 +44,7 @@ Our open-source projects are maintained by a dedicated team of developers. Feel | Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | | Alexis Barou | [LexBarou](https://github.com/LexBarou) | | Nicolai Nielsen | [niconielsen32](https://github.com/niconielsen32) | -| Joey Tjon | - | +| Joey Tjon | [NoCodeJoey](https://github.com/NoCodeJoey) | ## Contribution Guidelines From 65564a58b1930d065f97e23e8da1762125dbb5fa Mon Sep 17 00:00:00 2001 From: UltralyticsAssistant Date: Wed, 15 Jan 2025 12:20:34 +0000 Subject: [PATCH 9/9] Auto-format by https://ultralytics.com/actions --- docs/contributions/how-to-contribute.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md index 9079579..2c482c5 100644 --- a/docs/contributions/how-to-contribute.md +++ b/docs/contributions/how-to-contribute.md @@ -44,7 +44,7 @@ Our open-source projects are maintained by a dedicated team of developers. Feel | Tasha Anthony | [recruiter2002](https://github.com/recruiter2002) | | Alexis Barou | [LexBarou](https://github.com/LexBarou) | | Nicolai Nielsen | [niconielsen32](https://github.com/niconielsen32) | -| Joey Tjon | [NoCodeJoey](https://github.com/NoCodeJoey) | +| Joey Tjon | [NoCodeJoey](https://github.com/NoCodeJoey) | ## Contribution Guidelines