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

Toml #2

Merged
merged 2 commits into from
Dec 31, 2023
Merged

Toml #2

merged 2 commits into from
Dec 31, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Dec 31, 2023

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:

  1. Check for Existing Contributions: Before submitting, kindly explore existing PRs to ensure your contribution is unique and complementary.

  2. 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.

  3. 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.

  4. 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

Updating project structure and versioning strategy.

📊 Key Changes

  • The Python package directory can now be named src/ or your_package_name/.
  • The dynamic versioning is added to pyproject.toml, enabling the version to be set via the package itself.
  • template/__init__.py now correctly sets the __version__ attribute.

🎯 Purpose & Impact

  • The flexibility to name the package directory improves clarity for users on how to structure their own projects.
  • Dynamic versioning centralizes the source of the package version, reducing potential errors and streamlining the release process.
  • The fix in the __init__.py file corrects a syntax error, which can prevent possible bugs in version referencing.

@glenn-jocher glenn-jocher merged commit 6d50dbc into main Dec 31, 2023
1 check passed
@glenn-jocher glenn-jocher deleted the toml branch December 31, 2023 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant