Skip to content

feat: Include an API call example section in the pull request description #602

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.

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
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 16 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
## Description of the change

> Description goes here

## Type of change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## Related issues

> Issue links go here

## Usage Example

> Example of how to call it

## Checklists

### Development

- [ ] Lint rules pass locally
- [ ] The code changed/added as part of this pull request has been covered with tests
### Code review

### Code review

- [ ] This pull request has a descriptive title and information useful to a reviewer
- [ ] Issue from task tracker has a link to this pull request
- [ ] Issue from task tracker has a link to this pull request
8 changes: 7 additions & 1 deletion dangerfile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import collectCoverage, { ReportType } from '@instabug/danger-plugin-coverage';
const hasSourceChanges = danger.git.modified_files.some((file) =>
file.startsWith('lib/')
);
const hasModulesChanges = danger.git.modified_files.some((file) => file.startsWith('lib/src/modules/'));

const declaredTrivial =
!hasSourceChanges ||
danger.github.issue.labels.some((label) => label.name === 'trivial');
Expand All @@ -14,12 +16,16 @@ async function hasDescription() {
const hasNoDescription = danger.github.pr.body.includes(
'> Description goes here'
);
const hasNoExample = danger.github.pr.body.includes('> Example of how to call it');

if (hasNoDescription && linesOfCode > 10) {
fail(
'Please provide a summary of the changes in the pull request description.'
);
}

if (hasNoExample && linesOfCode > 10 && hasModulesChanges) {
warn('Please provide example of how to call it.');
}
if (!danger.git.modified_files.includes('CHANGELOG.md') && !declaredTrivial) {
warn(
'You have not included a CHANGELOG entry! \nYou can find it at [CHANGELOG.md](https://github.com/Instabug/Instabug-Flutter/blob/master/CHANGELOG.md).'
Expand Down