Usage

Rubyhub provides an easy way to setup default options for newly-created pull requests.

1. Firstly, generate config file

   $ rubyhub install

2. Secondly, fill in config.yml file with the data accordingly to the needs of all subteams in your repository.

 template:
   default: &default:
     base_branch: master
     labels:
       - needs review
       - another label
     assignees:
       - any
       - github
       - assignees
     reviewers:
       - any github reviewers
     jira_base_url: https://sample.atlassian.net/browse/
     push: true
     open: false
   backend:
     <<: *default
     reviewers:
       - some backend developer
       - another backend developer
   frontend:
     <<: *default
     reviewers:
       - some frontend developer
       - another frontend developer

3. Run pull request create command

   $ rubyhub create -t your_template_name

   , where your_template_name - is the option for one of the subteams default:, backend:, frontend: given in config.yml by you.

Example

For example, using the data mentioned above in config.yml and working within feature/MyTask-1399 branch

Command $ rubyhub create -t backend, would produce pull request to the branch master with the:

• Title: Feature | TASK-1399
• Labels: needs review, another label
• Assignees: any, github, assignees
• Reviewers: some backend developer, another backend developer
• Description title: JIRA ticket - https://sample.atlassian.net/browse/TASK-1399
• Description main body: would be taken from config.yml. If it wasn't provided in that one, it would search for description inside the file description.txt in the root of you app. You can leave both blank if you don't want to add any description to your PR.

Keep in mind, you can create as many options as you need in config.yml file.