diff --git a/README.md b/README.md index 4323cae..5c4568c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ +
+ +
+ # Bartholomew "The Butler" Smith -Description + +Bartholomew "The Butler" Smith is your personal assistant for managing your GitHub repositories. +This app automates repetitive tasks, helping you save time and focus on what’s important. +Here’s what GitHub Butler can do for you: +- **[Pull Request Management](pull-request.md)**: Automatically creates a pull request on the repository's default branch + when a branch is created among other things. + +With Bartholomew "The Butler" Smith, you can spend less time managing your repository and more time writing great code. +It’s like having a butler for your GitHub repository! :tophat: [![Code Quality](https://github.com/heitorpolidoro/bartholomew-smith/actions/workflows/code_quality.yml/badge.svg)](https://github.com/heitorpolidoro/bartholomew-smith/actions/workflows/code_quality.yml) -[![Upload Python Package](https://github.com/heitorpolidoro/bartholomew-smith/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/heitorpolidoro/bartholomew-smith/actions/workflows/pypi-publish.yml)
[![Latest Version](https://img.shields.io/github/v/release/heitorpolidoro/bartholomew-smith?label=Latest%20Version)](https://github.com/heitorpolidoro/bartholomew-smith/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/heitorpolidoro/bartholomew-smith) @@ -19,3 +30,14 @@ Description [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=heitorpolidoro_bartholomew-smith&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=heitorpolidoro_bartholomew-smith) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=heitorpolidoro_bartholomew-smith&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=heitorpolidoro_bartholomew-smith) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=heitorpolidoro_bartholomew-smith&metric=bugs)](https://sonarcloud.io/summary/new_code?id=heitorpolidoro_bartholomew-smith) + +## Thanks to +@gabriellamas for helping me with logo ideas + +## TODOs +- [ ] heitorpolidoro/bartholomew-smith#4 +- [ ] heitorpolidoro/bartholomew-smith#5 +- [ ] heitorpolidoro/bartholomew-smith#6 +- [ ] Auto-fix linter +- [ ] Check for TODOs in repository (create issues?) +- [ ] Dont Merge Yet if WiP or has a not checked item in the checklist diff --git a/img/bartholomew-logo.png b/img/bartholomew-logo.png new file mode 100644 index 0000000..0a2e3ca Binary files /dev/null and b/img/bartholomew-logo.png differ diff --git a/pull-request.md b/pull-request.md new file mode 100644 index 0000000..f5b9be0 --- /dev/null +++ b/pull-request.md @@ -0,0 +1,9 @@ +# Pull Request Management +Automatically creates a pull request on the repository's default branch when a branch is created. +Also it can copy the title and the body of an issue to use to create the pull request if: +- The branch starts with `issue-123` and there is an issue in the same repository with the number `123` + +## TODOs +- [ ] Able to link with issues in another repo? +- [ ] Click Up integration +- [ ] Jira integration