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

Updates community section #20

Merged
merged 2 commits into from
Nov 12, 2024
Merged

Updates community section #20

merged 2 commits into from
Nov 12, 2024

Conversation

Burhan-Q
Copy link
Contributor

@Burhan-Q Burhan-Q commented Oct 23, 2024

  • Rename contributions directory to community
  • Add index.md for Community section
  • Refactor navigation for changes

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Ultralytics has introduced placeholder pages for a comprehensive Handbook to guide community engagement and contributions.

πŸ“Š Key Changes

  • Added new placeholder documentation pages for "Community Engagement," "How to Contribute," and "Community Index" in the Ultralytics Handbook.
  • Included sections on the company's mission, values, operational workflows, and contribution guidelines.

🎯 Purpose & Impact

  • Guidance for Contributors: These pages outline forthcoming comprehensive information, providing potential contributors with an understanding of Ultralytics’ goals and values, as well as how they can participate.
  • Community Engagement: By previewing upcoming resources, the initiative aims to foster community interaction and involvement and provide clear directions on contributing.
  • Enhanced Transparency: Offers insights into the internal workings and collaboration guidelines of Ultralytics, promoting open-source contribution and continuous improvement across projects.

@Burhan-Q Burhan-Q added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 23, 2024
@Burhan-Q Burhan-Q self-assigned this Oct 23, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @Burhan-Q, thank you for submitting a PR to the ultralytics/handbook repository! πŸš€ This is an automated response, and an Ultralytics engineer will review your submission shortly.

Here's a checklist to ensure a smooth integration process:

  • βœ… Define a Purpose: Make sure your PR description clearly outlines the purpose and scope of your changes. Link to any relevant issues if applicable.
  • βœ… Synchronize with Source: Ensure your branch is up-to-date with the latest changes in the main branch of the ultralytics/handbook repository. You can do this via the 'Update branch' button or by running git pull and git merge main on your local machine.
  • βœ… Ensure CI Checks Pass: Confirm all Ultralytics Continuous Integration (CI) checks are green. If any checks fail, please address the issues accordingly.
  • βœ… Update Documentation: If you added or modified features, make sure to update the relevant documentation.
  • βœ… Add Tests: If applicable, ensure you have added or updated tests to cover your changes. Verify that all tests are passing.
  • βœ… Sign the CLA: If this is your first contribution to Ultralytics, please sign our Contributor License Agreement (CLA) by stating "I have read the CLA Document and I sign the CLA" in a new comment.
  • βœ… Minimize Changes: Aim to keep your changes to the minimum necessary to achieve the desired outcome. This is in line with the philosophy of focusing on essential changes for clarity and maintainability.

For more guidance, do check out our Contributing Guide. If you have any questions, feel free to ask by commenting below. Thank you for your efforts in enhancing Ultralytics’ community documentation! πŸ“–βœ¨

@glenn-jocher glenn-jocher merged commit 7e94d54 into main Nov 12, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the community branch November 12, 2024 09:49
@glenn-jocher
Copy link
Member

@Burhan-Q this is great, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants