You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remember, your PRs won't be reviewed until these criteria are met:
32
-
33
-
1. We don't merge PRs with poor code quality.
34
-
1. Follow coding best practices such that CodeRabbit.ai approves your PR.
35
-
1. We don't merge PRs with failed tests.
36
-
1. When tests fail, click on the `Details` link to learn more.
37
-
1. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
38
-
1. Tests may fail if you edit sensitive files. Ask to add the `ignore-sensitive-files-pr` label if the edits are necessary.
39
-
1. We cannot merge PRs with conflicting files. These must be fixed.
40
-
41
-
Our policies make our code better.
42
-
43
-
### Reviewers
44
-
45
-
Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
46
-
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:
47
-
48
-
1. comments in this PR or
49
-
1. our slack channel
50
-
51
-
#### Reviewing Your Code
52
-
53
-
Your reviewer(s) will have the following roles:
54
33
55
-
1. arbitrators of future discussions with other contributors about the validity of your changes
56
-
2. point of contact for evaluating the validity of your work
57
-
3. person who verifies matching issues by others that should be closed.
58
-
4. person who gives general guidance in fixing your tests
34
+
This PR will be reviewed according to the [Palisadoes Contributing Guidelines](https://developer.palisadoes.org/docs/contributor-guide/contributing)
59
35
60
-
### CONTRIBUTING.md
61
-
62
-
Read our CONTRIBUTING.md file. Most importantly:
63
-
64
-
1. PRs with issues not assigned to you will be closed by the reviewer
65
-
1. Fix the first comment in the PR so that each issue listed automatically closes
66
-
67
-
### Other
68
-
69
-
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.
70
-
2. Read the CONTRIBUTING.md file make
36
+
Thanks for contributing!
71
37
72
38
- name: Greeting Message to User
73
-
uses: actions/first-interaction@v1
39
+
uses: actions/first-interaction@v3
74
40
with:
75
41
repo-token: ${{ secrets.GITHUB_TOKEN }}
76
-
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."
42
+
pr-message: 'Congratulations on making your first PR!'
Copy file name to clipboardExpand all lines: docs/contributor-guide/pr-guidelines.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,17 @@ If you are concerned that a larger design will be lost in a string of small PRs,
62
62
63
63
Note all commits in a PR are squashed when merged to the main branch so there is one commit per PR after merge.
64
64
65
+
## The Role of Reviewers
66
+
67
+
Your reviewer(s) will have the following roles:
68
+
69
+
1. arbitrators of future discussions with other contributors about the validity of your changes
70
+
2. point of contact for evaluating the validity of your work
71
+
3. person who verifies matching issues by others that should be closed.
72
+
4. person who gives general guidance in fixing your tests
73
+
74
+
Please follow thier advice and discuss the rationale if you feel the requests are not in the best long term interest of the code base or don't meet any best practices.
75
+
65
76
## Pull Request Best Practices
66
77
67
78
In order to give everyone a chance to submit a pull request and contribute to our repositories please be aware of the guidelines we abide by:
@@ -74,7 +85,11 @@ In order to give everyone a chance to submit a pull request and contribute to ou
74
85
1. Do not start working on any open issue and raise a PR unless the issue is assigned to you. PRs that don't meet these guidelines will be closed.
75
86
76
87
1. All pull requests must have test units.
77
-
- Valid tests must cover at least 95% of the submitted code and 100% is preferred. If, for some reason, it is not possible to add tests, please let us know and explain why. In that case, you'll need to tell us what steps you followed to manually test your changes.
88
+
1. Valid tests must cover at least 95% of the submitted code and 100% is preferred. If, for some reason, it is not possible to add tests, please let us know and explain why. In that case, you'll need to tell us what steps you followed to manually test your changes.
89
+
90
+
2. We don't merge PRs with failed tests. When tests fail, click on the `Details` link of the test to learn more.
91
+
92
+
3. Tests may fail if you edit sensitive files. Ask to add the `ignore-sensitive-files-pr` label if the edits are necessary.
78
93
79
94
1.[Use this method to automatically close the issue when the PR is completed.](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)
0 commit comments