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

Update SECURITY.md #59

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Update SECURITY.md #59

merged 1 commit into from
Dec 5, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Dec 5, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced security documentation with additional FAQs detailing key security measures like Snyk, CodeQL, and Dependabot, plus improved badge linkage.

πŸ“Š Key Changes

  • Updated CodeQL badge link to reflect the correct workflow path.
  • Added a FAQ section explaining:
    • Security measures implemented (e.g., Snyk, CodeQL, Dependabot).
    • How specific tools like Snyk and CodeQL work to protect projects.
    • Private vulnerability reporting process for secure issue disclosure.

🎯 Purpose & Impact

  • Improved Clarity: Provides clear, detailed explanations of Ultralytics’ security practices.
  • Enhanced Transparency: Reassures users and contributors by showcasing proactive security tools and workflows πŸ”’.
  • Actionable Insights: Empowers users to safely report vulnerabilities, fostering a collaborative and secure environment.

Deepened documentation ensures trust, security, and practical guidance for users and developers alike! πŸŽ‰

Signed-off-by: Glenn Jocher <[email protected]>
@glenn-jocher glenn-jocher self-assigned this Dec 5, 2024
@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Dec 5, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/.github πŸš€ PR! To ensure a seamless integration of your work, please review the following checklist:

  • βœ… Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • βœ… Synchronize with Source: Confirm your PR is synchronized with the ultralytics/.github main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • βœ… Update Documentation: Update the relevant documentation for any new or modified features.
  • βœ… Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • βœ… Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • βœ… Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." β€” Bruce Lee

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! πŸš€

This is an automated response, but rest assured that an Ultralytics engineer will review your PR and provide further feedback soon. 😊

@glenn-jocher glenn-jocher merged commit 6a25619 into main Dec 5, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch December 5, 2024 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops GitHub Devops or MLops documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants