https://github.com/bredah/pull-request-challenge

https://github.com/bredah/pull-request-challenge

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bredah/pull-request-challenge
• Owner: bredah
• Created: 2022-04-10T22:21:47.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-10T23:57:30.000Z (almost 3 years ago)
• Last Synced: 2023-03-02T21:42:20.505Z (almost 2 years ago)
• Language: Python
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PR Challeng

This project presents a simple solution for validating standards and good

practices, as well as validations in a pull request for GitHub (Actions).

## Inpection

This solution using GitHub Actions to validate a pull request (new, reopened or

edited), this mechanism performs the following assessments:

- validate the contents of the `Pull Request` body

  - If not contains the words: "please", "appreciate", "would be great", failed

  the PR and skip the linting.

- run the linting

  - if not respecting standard code formatter or best practices, this step

  would fail

### Pull Request

Here are some examples of validations in action:

- PR without expected word in the body: [link]() - [pull request](https://github.com/bredah/pull-request-challenge/runs/5964172514)

- PR with expected word in the body: [link]() - [pull request](https://github.com/bredah/pull-request-challenge/runs/5964417143)

#### GitHub Actions (hook)

In the `.github/workflows/pull_request.yml` you will find the hook to be

executed after a `PULL REQUEST`.

With each new PR, the code quality inspection will be performed automatically

via Actions. This process was configured by default in the project, for this

you will need:

- Access the project settings

- On side menu, select the `Branch` option

- Select the `Add new rule` option

- Fill the `Branch name pattern` field with the value: "main"

- Select the option `Require status checks to pass before merging` and then

  fill in the field with the value `inspection`

- Select the `Create` option which is located at the bottom of the page

#### Pull Request Template

In the `.github/pull_request_template.md` contains a template used when a

developer open a new PR, it will be filled in automatically, providing the

basic information ans structure, so the developer must modify and fill in the

remaining information to the PR.

### External Libraries

- [pre-commit](https://pre-commit.com): used to validate best practices on

  developed code, after adding a file in the commit, run the `make Inspection`

  command to run lint locally.