Skip to content

Commit

Permalink
doc: add one more section
Browse files Browse the repository at this point in the history
  • Loading branch information
volodya-lombrozo committed Dec 6, 2024
1 parent 779323c commit f5b854e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,32 @@

Newsman is a simple script that collects information about a developer's weekly activity on GitHub and creates a human-readable summary of the work done. To create the summary, Newsman asks ChatGPT to handle all the information about a developer's activity, including their pull requests and created issues.

## How it Works

`newsman` sends multiple requests to GitHub to retrieve the following data:

1. **Recently Closed Pull Requests by the Author**
The tool fetches pull requests that were closed recently and were created by the specified author.
Example query:

```
is:pr author:volodya-lombrozo created:>=2024-11-29 repo:objectionary/jeo-maven-plugin repo:objectionary/opeo-maven-plugin
```

2. **Open Issues Assigned to the Author with the `soon` Label**
The tool retrieves issues that:
- Were opened in the last year
- Are currently open
- Are assigned to the specified author
- Have the label `soon`

Example query:
```
is:issue is:open assignee:volodya-lombrozo created:>=2023-12-06 repo:objectionary/jeo-maven-plugin repo:objectionary/opeo-maven-plugin label:soon
```

Once the data is retrieved, the script analyzes it using the model specified with the `--model` option.

## Install

To install [newsman](https://rubygems.org/gems/newsman) from RubyGems.org use the following command:
Expand Down Expand Up @@ -53,6 +79,8 @@ Also you can download this repository and run the newsman script directly using
./bin/newsman --name "Vladimir Lombrozo" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin
```

Actually, this command is also useful during development process.

## How to build a gem from sources

To create a newsman gem from sources first of all you need to build it:
Expand Down
1 change: 0 additions & 1 deletion lib/newsman/issues.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
# This class represents a GitHub Issue abstraction created by a user.
class Issue


attr_accessor :title, :body, :repo, :number

def initialize(title, body, repo, number, **additional)
Expand Down

0 comments on commit f5b854e

Please sign in to comment.