Skip to content

chore: initialize repository with GitHub workflows and pre-commit jobs#2

Merged
briangreunke merged 7 commits into
mainfrom
chore/pre-commit
Apr 11, 2025
Merged

chore: initialize repository with GitHub workflows and pre-commit jobs#2
briangreunke merged 7 commits into
mainfrom
chore/pre-commit

Conversation

@briangreunke
Copy link
Copy Markdown
Contributor

@briangreunke briangreunke commented Apr 9, 2025

This commit sets up the initial repository structure with GitHub workflow configurations. The changes include:

  • Added GitHub workflow configurations for CI/CD
  • Set up pre-commit hooks and linting configurations
  • Created PR templates and issue templates
  • Added code of conduct and contribution guidelines
  • Configured renovate for dependency management
  • Updated project structure with tests directory
  • Enhanced pyproject.toml with additional configurations
  • Added README generation script and template

Generated Summary:

Summary of Changes:

  • Added a comprehensive CODE_OF_CONDUCT.md to establish clear behavioral expectations within the project community.
  • Created a CONTRIBUTING.md file outlining the contribution process, including pull request guidelines and CLA requirements.
  • Introduced multiple issue templates (bug_report.yaml, feature_request.yaml) to streamline issue reporting.
  • Implemented a PULL_REQUEST_TEMPLATE.md to ensure consistent and informative pull request descriptions.
  • Established GitHub workflows for various tasks:
    • meta-labeler.yaml for auto-labeling pull requests.
    • semantic-prs.yaml for validating pull request titles.
    • pre-commit.yaml for enforcing pre-commit checks and code quality.
    • semantic-release.yaml for managing versioning and releases based on Git tags.
    • Others for handling Renovate bot configurations and managing labels.

Added:

  • Code of Conduct and Contribution guidelines.
  • Issue and pull request templates for consistent documentation.
  • GitHub Actions workflows to automate labeling, semantic release, and dependency management.

Potential Impact:

  • Establishing a Code of Conduct is expected to create a more inclusive community.
  • Streamlined contribution and issue reporting processes may enhance collaboration and code quality.
  • The introduction of automated workflows will help maintain project standards and facilitate smoother releases.

This summary was generated with ❤️ by rigging

This commit sets up the initial repository structure with GitHub workflow
configurations. The changes include:

- Added GitHub workflow configurations for CI/CD
- Set up pre-commit hooks and linting configurations
- Created PR templates and issue templates
- Added code of conduct and contribution guidelines
- Configured renovate for dependency management
- Updated project structure with tests directory
- Enhanced pyproject.toml with additional configurations
- Added README generation script and template
@briangreunke briangreunke requested a review from monoxgas April 9, 2025 20:44
- Add  to context.py to suppress type checking for entire file
- Fix type ignore format in transformers.py by removing unnecessary bracket annotation
@briangreunke briangreunke requested a review from rdheekonda April 9, 2025 21:48
Copy link
Copy Markdown
Contributor

@monoxgas monoxgas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of scary stuff in here, but I'm going to trust you :)

Copy link
Copy Markdown
Contributor

@rdheekonda rdheekonda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty neat template. This PR would be super helpful in our upcoming projects, specifically Python repos.

@briangreunke briangreunke merged commit 3e31bd3 into main Apr 11, 2025
6 checks passed
@monoxgas monoxgas deleted the chore/pre-commit branch April 25, 2025 00:37
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.

3 participants