https://github.com/s-ayanide/sniffy

Sniffy is wise and caring and would always be there to ease your task and take the workload off your shoulders. He would sniff the size of PRs and let you know automatically as well as attach any labels depending on area the PR is submitted.
https://github.com/s-ayanide/sniffy

bot github-app pr sniffy

Last synced: about 1 month ago
JSON representation

Sniffy is wise and caring and would always be there to ease your task and take the workload off your shoulders. He would sniff the size of PRs and let you know automatically as well as attach any labels depending on area the PR is submitted.

• Host: GitHub
• URL: https://github.com/s-ayanide/sniffy
• Owner: S-ayanide
• License: mit
• Created: 2020-07-16T14:57:34.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-05T09:05:30.000Z (over 2 years ago)
• Last Synced: 2024-10-11T12:50:51.660Z (2 months ago)
• Topics: bot, github-app, pr, sniffy
• Language: JavaScript
• Homepage: https://github.com/apps/codesniffy
• Size: 116 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


# Sniffy

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Sniffy is wise and caring and would always be there to ease your task and take the workload off your shoulders. He would sniff the size of PRs and let you know automatically as well as attach any labels depending on area the PR is submitted.

## Sizing

| Name | Description |

| ---- | ----------- |

| `size/XS` | Denotes a PR that changes 0-9 lines. |

| `size/S` | Denotes a PR that changes 10-29 lines. |

| `size/M` | Denotes a PR that changes 30-99 lines. |

| `size/L` | Denotes a PR that changes 100-499 lines. |

| `size/XL` | Denotes a PR that changes 500-999 lines. |

| `size/XXL` | Denotes a PR that changes 1000+ lines. |

Sniffy calculates the size of a PR as

```

total additions + total deletions - (all generated¹ file additions/deletions)

```

¹ A generated file is either one of the standard generated files as defined in [noqcks/generated](https://github.com/noqcks/generated/blob/master/lib/generated.js) or defined with `linguist-generated=true` in a `.gitattributes` file. See [Customizing how changed files appear on GitHub](https://help.github.com/articles/customizing-how-changed-files-appear-on-github/) for more information.

## Setup

This GitHub app runs on probot. It makes it very easy to create new GitHub apps.

If you want to run or develop Sniffy just follow the commands

below. hit localhost:3000, and follow the probot instructions.

```sh

# Install dependencies

npm install

# Run the bot

npm start

```

## License

[MIT](LICENSE) © 2020 Sayan Mondal