Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you 🙏 for your contribution to Ultralytics 🚀! Your effort in enhancing our repositories is greatly appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, please follow these steps:
Check for Existing Contributions: Before submitting, kindly explore existing PRs to ensure your contribution is unique and complementary.
Link Related Issues: If your PR addresses an open issue, please link it in your submission. This helps us better understand the context and impact of your contribution.
Elaborate Your Changes: Clearly articulate the purpose of your PR. Whether it's a bug fix or a new feature, a detailed description aids in a smoother integration process.
Ultralytics Contributor License Agreement (CLA): To uphold the quality and integrity of our project, we require all contributors to sign the CLA. Please confirm your agreement by commenting below:
I have read the CLA Document and I hereby sign the CLA
For more detailed guidance and best practices on contributing, refer to our ✅ Contributing Guide. Your adherence to these guidelines ensures a faster and more effective review process.
🛠️ PR Summary
Made with ❤️ by Ultralytics Actions
🌟 Summary
Added automatic code formatting with Ruff and improved project structure documentation.
📊 Key Changes
.github/workflows/ruff.yml
for automated code formatting using Ruff on every push and pull request tomain
.docs/
directory with README instructions on using MkDocs for project documentation.README.md
to reflect changes in project organization, emphasizing thesrc/
directory's role.pyproject.toml
for managing build, packaging, and tool configurations.template/
source directory with initial contents, including a placeholder__init__.py
with version number and a basic module (module1.py
) with a functionadd_numbers
.tests/
directory with guidelines in its README and a test script (test_module1.py
) for theadd_numbers
function.🎯 Purpose & Impact
docs/
directory, along with MkDocs setup, ensures project documentation remains accessible and up-to-date.template/
source directory defines a clear structure that can be easily scaled and understood by contributors.pyproject.toml
centralizes configuration, simplifying the process of building and deploying the project.tests/
directory framework encourages thorough testing, which will enhance the reliability of the codebase.