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 : Standardize the Pull Request GitHub Action to match Talawa API #1288

Conversation

aialok
Copy link
Contributor

@aialok aialok commented Dec 26, 2023

What kind of change does this PR introduce?

  • This pull request standardizes TypeScript GitHub Action workflows by introducing two dedicated jobs: Code-Quality-Checks and Test-Application. The Code-Quality-Checks job handles performing linting, formatting checks and type-error check while the Test-Application job, reliant on the former, focuses on testing the application. This change enhances workflow organization, promoting clear separation of code quality and testing concerns for improved maintainability.

Issue Number:

Fixes #1277

Did you add tests for your changes?

  • No

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

  • This PR standardizes TypeScript workflows with two jobs: Code-Quality-Checks for linting, formatting, and package installation, and Test-Application for testing. The separation enhances workflow clarity and maintainability.

Does this PR introduce a breaking change?

  • No

Other information

Have you read the contributing guide?

  • Yes

@aialok aialok requested a review from palisadoes as a code owner December 26, 2023 10:07
Copy link

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link

codecov bot commented Dec 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0e9e341) 96.23% compared to head (4d59bcf) 96.23%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1288   +/-   ##
========================================
  Coverage    96.23%   96.23%           
========================================
  Files          137      137           
  Lines         3344     3344           
  Branches       939      939           
========================================
  Hits          3218     3218           
  Misses         120      120           
  Partials         6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@palisadoes palisadoes merged commit dfe1dc9 into PalisadoesFoundation:develop Dec 27, 2023
8 of 9 checks passed
VaibhavTalkhande added a commit to VaibhavTalkhande/talawa-admin that referenced this pull request Dec 28, 2023
@aialok aialok deleted the github-action-workflow-refactor-develop branch January 7, 2024 12:08
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.

2 participants