Skip to content

Improve CI: documentation and naming #50

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.

Sign up for GitHub

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

Merged
UlisesGascon merged 2 commits into from
Dec 7, 2024
Merged

Improve CI: documentation and naming #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9409811
fix: rename the pipeline to reflect the objective
UlisesGascon Dec 7, 2024
3008d06
docs: include the PR comments in the contribution guide
UlisesGascon Dec 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/review-compliance-checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Check Migrations
name: Check Compliance Checks

on:
pull_request:
Expand All @@ -11,7 +11,7 @@ permissions:
pull-requests: write

jobs:
check-migrations:
check-compliance-checks:
runs-on: ubuntu-latest

steps:
Expand Down
20 changes: 19 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ You have several templates available:

## Pull Requests

### Create a good PR in this project
Here are some recommendations for creating PRs in this project.

Creating a high-quality Pull Request (PR) helps maintainers review your contribution efficiently and ensures it aligns with the project's standards. Follow these steps to make your PR outstanding:
Expand Down Expand Up @@ -82,6 +83,23 @@ Before submitting your PR:

By following these steps, you'll create a high-quality PR that is easier to review and more likely to be accepted. Thank you for contributing!

### Additional Support

This project provides automatic comments in PRs when certain conditions are met. These comments include checklists to guide contributors through the required steps. Here are some examples:

**When a compliance check is added/modified**

The bot provides this checklist to ensure the updated compliance checks meet all project requirements.

![Checklist for compliance check updates with questions to validate changes, including schema generation, migrations, tests, and severity validation](https://github.com/user-attachments/assets/fb7fddbf-1592-4213-bf4d-821a7f8c8be8)

**When a migration is added/modified**

This checklist ensures that contributors validate schema generation and rollback behavior while avoiding edits to existing migrations.

![Checklist for migration updates with reminders about schema generation and rollback testing, and a note to avoid editing existing migrations](https://github.com/user-attachments/assets/169bea0d-b2aa-4c7e-84e2-9fb4f52ac289)


## Current Initiatives

Here you can find the best ways to make meaningful contributions to the project.
Expand Down Expand Up @@ -156,4 +174,4 @@ By making a contribution to this project, I certify that:
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```
```