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 README #1

Merged
merged 2 commits into from
Dec 31, 2023
Merged

Update README #1

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

Added automatic code formatting with Ruff and improved project structure documentation.

📊 Key Changes

  • 🔧 Introduced .github/workflows/ruff.yml for automated code formatting using Ruff on every push and pull request to main.
  • 📂 Added a new docs/ directory with README instructions on using MkDocs for project documentation.
  • 👩‍💻 Updated README.md to reflect changes in project organization, emphasizing the src/ directory's role.
  • 📦 Introduced pyproject.toml for managing build, packaging, and tool configurations.
  • 🧰 Created a new template/ source directory with initial contents, including a placeholder __init__.py with version number and a basic module (module1.py) with a function add_numbers.
  • ✅ Added a tests/ directory with guidelines in its README and a test script (test_module1.py) for the add_numbers function.

🎯 Purpose & Impact

  • 💻 The Ruff integration enforces a consistent code style automatically, improving readability and maintainability.
  • 📘 The docs/ directory, along with MkDocs setup, ensures project documentation remains accessible and up-to-date.
  • 🏗️ The 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.
  • 🧪 The tests/ directory framework encourages thorough testing, which will enhance the reliability of the codebase.

@glenn-jocher glenn-jocher merged commit 5b5863f into main Dec 31, 2023
@glenn-jocher glenn-jocher deleted the update 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