https://github.com/jongear/issue-connector

Connect issues to Pull Requests based off feature branch naming conventions
https://github.com/jongear/issue-connector

Last synced: 5 months ago
JSON representation

Connect issues to Pull Requests based off feature branch naming conventions

• Host: GitHub
• URL: https://github.com/jongear/issue-connector
• Owner: jongear
• License: isc
• Created: 2019-06-24T18:16:41.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T19:26:05.000Z (over 3 years ago)
• Last Synced: 2023-03-02T04:05:58.330Z (over 3 years ago)
• Language: JavaScript
• Homepage: https://issue-connector.gear.dev
• Size: 3.44 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
**[Setup](#setup)** | **[Contributing](#contributing)** | **[License](#license)**

# Pull Request Issue Connector

> A GitHub App built with [Probot](https://github.com/probot/probot) that connects issues to Pull Requests based off feature branch naming conventions

The Pull Request Issue Connector bot will identify pull requests from branches that denote an issue number

and will automatically cross reference the issue within the pull request. If you forgot to add the issue number

to your pull request message the bot will automatically add the cross reference for you.

![Walkthrough of bot in action](assets/bot-in-action.gif)

The only requirement for the bot to be able to find your issue is for your branch name to start with the issue number

you would like attached to your pull request.

e.g. - Say we want to open a pull request to resolve `Issue #1: Add Travis`

The following are valid branch names that the bot will understand, `1`, `1-travis-build`, `1-{any string}` and automatically handle assignment for us

## Setup

```sh

# Install dependencies

npm install

# Run the bot

npm start

# Open the following link in the browser to install the bot on a GitHub repository

http://localhost:3000

```

## Contributing

If you have suggestions for how issue-connector could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the [Contributing Guide](CONTRIBUTING.md).

## License

[ISC](LICENSE) © 2019 Jon Gear