Skip to content

feat(template): moves tests & linter fixes #3

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

Open
vic-unimedia wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(template): moves tests & linter fixes #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 18 additions & 15 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
__IMPORTANT__
# **IMPORTANT**

In order to help other team mates in having context of the ticket and knowing which work has been made, it's mandatory to fill all the mandatory (*) sections (that includes replacing the text placeholders to describe properly the ticket). If any of them have not been filled in, the PR is not ready to review, so people will wait to do the review. (remove this note when you're sure all of the reqs. are fulfilled)

## (*)Description
## **Description**
Copy link
Copy Markdown
Member

@jfragosoperez jfragosoperez Nov 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

try to keep the () here and in the other places you removed it, as the description above explains that fields highlighted with the () are mandatory to be filled, so it's important we let people know the "must fill in"s


Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

## (*)Type of change
## **Type of change**

Please delete options that are not relevant.

Expand All @@ -15,28 +15,24 @@ Please delete options that are not relevant.
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# (*)How Has This Been Tested?

Please describe the tests that you ran to verify your changes. For each of the usecases, provide instructions so the team can understand what's been solved in this ticket. Please provide screenshots for each of them, so we know how do you tested for endpoints, bugfixes, etc which are exposed independently if it's an internal GRPC service, public service, etc.

__An assertment such as 'make test'__ shows the test pass __will only be enough if we're unit testing a task which was broken into smaller unit pieces__ (i.e. repository, use-case, controller, etc that still is not coupled to the server) __that are not coupled/exposed yet__. The __rest of the tickets will include screenshots showing how the functionality was tested__.

- [ ] Test A

# (*)Checklist:
## **Checklist**

- [ ] (*)Branch name follows our guidelines naming convention
```

```shell
{{feature|bugfix|hotfix|docs}}/MMC-{{ticket_id_on_linear}}-{{short_title}}
```
- [ ] (*)The commit message follows our guideline convention
```

- [ ] (*)The commit message follows our guideline convention

```shell
{{feat|docs|style|refactor|test|chore|fix|hotfix}}({{scope}}): {{short_title}} (**NOTE** scope is usually the name of the micro)

{{ticket_description}}

resolves: MMC-{{ticket_id_on_linear}}
```

- [ ] This ticket requires business to validate its resolution before being able to release
- [ ] (*)My code follows the style guidelines of this project
- [ ] (*)I have performed a self-review of my own code
Expand All @@ -48,3 +44,10 @@ resolves: MMC-{{ticket_id_on_linear}}
- [ ] (*)I've reviewed and ensured all dependant components and config have been added and once merged, the functionality can be deployed to any environment
- [ ] (*)I'll remember to squash all the commits (if multiple) when merging to develop. In case of a PR against main, I'll merge main into develop first and once the PR is approved, I'll just merge (no squash)

## **How Has This Been Tested?**

Please describe the tests that you ran to verify your changes. For each of the usecases, provide instructions so the team can understand what's been solved in this ticket. Please provide screenshots for each of them, so we know how do you tested for endpoints, bugfixes, etc which are exposed independently if it's an internal GRPC service, public service, etc.

An assertment such as `make test` shows the test pass **will only be enough if we're unit testing a task which was broken into smaller unit pieces** (i.e. repository, use-case, controller, etc that still is not coupled to the server) **that are not coupled/exposed yet**. The **rest of the tickets will include screenshots showing how the functionality was tested**.

- [ ] Test A