-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(pull-request): add some expectations for PR as well as lint support
Adds expectations for PR creation as well as a reusable workflow that can be used to lint PRs.
- Loading branch information
Showing
4 changed files
with
77 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
name: CI | ||
|
||
on: | ||
pull_request: | ||
types: [edited, opened, reopened, synchronize] | ||
branches: [main] | ||
|
||
jobs: | ||
pr-lint: | ||
name: PR Lint | ||
uses: ./.github/workflows/reusable-workflow.pr-lint.yaml | ||
secrets: inherit |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
name: "Workflow: PR Lint" | ||
|
||
on: | ||
workflow_call: | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
publish: | ||
name: Lint PR | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Validate Checklists | ||
uses: roryq/checkmate@master |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Pull Request standards | ||
|
||
Our baseline standards follow | ||
teh [GitHub: Best practices for pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests) | ||
|
||
## Additional standards and expectations | ||
|
||
### Standard names for checks | ||
|
||
When creating status checks, we expect the following names to be used: | ||
|
||
- Lint | ||
- Test | ||
- PR Lint | ||
|
||
#### Lint | ||
|
||
Perform linting checks on the codebase. This should include checks for formatting, style, and other linting checks. It | ||
is suggested to use a tool such as pre-commit to perform these checks. | ||
|
||
#### Test | ||
|
||
When you have the ability to run tests, we expect them to run on all PRs and report as `Test`. | ||
|
||
#### PR Lint | ||
|
||
Not only should you look into writing good code and commits, but your pull requests should also be written with | ||
intention. Where possible, we should add appropriate linting. These should repot as `PR Lint`. | ||
|
||
##### Checkboxes | ||
|
||
Adding checkboxes to PRs is a really powerful way to help reviewers understand what you have done and what you expect to | ||
be done. We suggest the following checkboxes be added to PRs: | ||
|
||
- Use [Checkmate checkboxes](https://github.com/RoryQ/checkmate) | ||
- Use the reusable workflow in this repo to lint your PRs | ||
- Have a requited check for `PR Lint` |