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]: Implement GitHub Workflow for Pre-Commit Checks and Validation #112

Open
6 tasks
rajveer43 opened this issue Aug 23, 2023 · 0 comments · May be fixed by #113 or #119
Open
6 tasks

[feature]: Implement GitHub Workflow for Pre-Commit Checks and Validation #112

rajveer43 opened this issue Aug 23, 2023 · 0 comments · May be fixed by #113 or #119
Labels
enhancement New feature or request

Comments

@rajveer43
Copy link
Contributor

rajveer43 commented Aug 23, 2023

Description

As we continue to enhance the development process of our repository, it's essential to ensure code quality and consistency. This issue aims to implement an automated GitHub Workflow that performs pre-commit checks and validation on every push. By doing so, we can catch potential issues early in the development cycle and maintain a high standard of code quality.

Proposed Solution

We'll set up a GitHub Actions workflow using a YAML configuration file. This workflow will trigger on every push to any branch, initiating a series of checks that we define. These checks may include linting, code formatting, running tests, and other validations tailored to our project's requirements.

Tasks

  • Create a .github/workflows directory within the repository.
  • Inside the workflows directory, add a YAML file named pre-commit-checks.yml.
  • Define the workflow trigger to run on every push event to any branch.
  • Specify the necessary jobs and steps within the YAML file for pre-commit checks.
  • Integrate tools or scripts for code linting, formatting, testing, and other relevant checks.
  • Set up conditional steps to display logs or messages in case of check failures.

Acceptance Criteria

  • The GitHub Workflow should trigger automatically on every push to any branch.
  • The workflow should successfully perform the specified pre-commit checks and validations.
  • In case of check failures, the workflow should display logs or messages indicating the issues.

For more information, @ShishirPatil Will be here to help!

@rajveer43 rajveer43 added the enhancement New feature or request label Aug 23, 2023
@vivekkhimani vivekkhimani linked a pull request Aug 30, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
1 participant