Skip to content

Conversation

@sql-hkr
Copy link
Owner

@sql-hkr sql-hkr commented Oct 17, 2025

This pull request adds a comprehensive CONTRIBUTING.md file to the project, providing clear guidelines for new contributors. The document covers setup instructions, development workflows, testing, linting, documentation, and the pull request process, making it easier for others to contribute effectively.

Contributor onboarding and workflow documentation:

  • Adds a detailed CONTRIBUTING.md with instructions for local development setup, including environment creation, dependency installation (with both uv and pip), and running tests.
  • Outlines standards for testing, linting (using ruff), documentation updates, and example usage to ensure code quality and maintainability.
  • Describes the preferred pull request process, including branch naming conventions, commit message guidelines, and a PR checklist to streamline code review.
  • Includes sections on code of conduct, reporting security issues, and licensing to clarify community expectations and legal terms.

@sql-hkr sql-hkr linked an issue Oct 17, 2025 that may be closed by this pull request
@sql-hkr sql-hkr merged commit 75f59aa into main Oct 17, 2025
1 check passed
@sql-hkr sql-hkr deleted the feat/contributing-guidelines branch October 17, 2025 14:50
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.

Create a CONTRIBUTING.md file

1 participant