Setting Up Codecov Environment (Documentation Update) #1376
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
############################################################################## | |
############################################################################## | |
# | |
# NOTE! | |
# | |
# Please read the README.md file in this directory that defines what should | |
# be placed in this file | |
# | |
############################################################################## | |
############################################################################## | |
name: PR Target Workflow | |
on: | |
pull_request_target: | |
jobs: | |
PR-Greeting: | |
name: Pull Request Target | |
runs-on: ubuntu-latest | |
steps: | |
- name: Add the PR Review Policy | |
uses: thollander/actions-comment-pull-request@v2 | |
with: | |
comment_tag: pr_review_policy | |
message: | | |
## 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 | |
1. 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 | |
1. Fix the first comment in the PR so that each issue listed automatically closes | |
### Other | |
1. :dart: 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 | |
- name: Greeting Message to User | |
uses: actions/first-interaction@v1 | |
with: | |
repo-token: ${{ secrets.GITHUB_TOKEN }} | |
pr-message: "Congratulations on making your first PR! :confetti_ball: If you haven't already, check out our [Contributing Guidelines](https://github.com/PalisadoesFoundation/talawa-admin/blob/-/CONTRIBUTING.md) and [PR Reporting Guidelines](https://github.com/PalisadoesFoundation/talawa-admin/blob/-/PR_GUIDELINES.md) to ensure that you are following our guidelines for contributing and creating PR." |