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

Feature/pre commit formatter #1393

Merged
merged 10 commits into from
Apr 14, 2023
Merged

Feature/pre commit formatter #1393

merged 10 commits into from
Apr 14, 2023

Conversation

Swiftyos
Copy link
Contributor

@Swiftyos Swiftyos commented Apr 14, 2023

Background

As our codebase grows and the number of contributors increases, it becomes essential to establish best practices and maintain a consistent coding style across the project. Integrating linting and pre-commit hooks can help us achieve this goal by automating code formatting before any changes are committed to the repository.

Changes

  • Added linting using the black code formatter to enforce a consistent coding style.
  • Implemented pre-commit hooks using the pre-commit package to run black before each commit.
  • Updated the project documentation to explain the usage of linting and pre-commit hooks, along with instructions on how to set them up for contributors.

Documentation

The changes are documented as follows:

  • In-code comments explaining the configuration of the pre-commit hooks in the .pre-commit-config.yaml file.
  • Updated CONTRIBUTING.md file, detailing the linting and pre-commit hooks setup process.

PR Quality Checklist

  • My pull request is atomic and focuses on a single change.
  • I have thoroughly tested my changes with multiple different prompts.
  • I have considered potential risks and mitigations for my changes.
  • I have documented my changes clearly and comprehensively.
  • I have not snuck in any "extra" small tweaks or changes.

richbeales
richbeales previously approved these changes Apr 14, 2023
richbeales
richbeales previously approved these changes Apr 14, 2023
richbeales
richbeales previously approved these changes Apr 14, 2023
@richbeales richbeales dismissed their stale review April 14, 2023 20:43

merge conflict

sindlinger pushed a commit to Orgsindlinger/Auto-GPT-WebUI that referenced this pull request Sep 25, 2024
…commit-formatter

Feature/pre commit formatter
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