Skip to content

Commit da90ba4

Browse files
sarvesh211999jgbarah
authored andcommitted
added info regarding param
1 parent 8442d02 commit da90ba4

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

perceval/github.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@ In that help banner, we see two different ways of using it:
1616
* with no credentials
1717
* with a user token
1818

19+
## Retrieving from GitHub with category param
20+
21+
```bash
22+
(perceval) $ perceval github --category issue grimoirelab perceval
23+
...
24+
```
25+
26+
You can pass category as parameter which take issue,pull_request,commit and repository when using Github Perceval backend.
27+
Note that in GitHub every pull request is an issue, but not every issue is a pull request. Thus, the issues returned may contain pull request information (included in the field `pull_request` within the issue).
28+
29+
1930
## Retrieving from GitHub with no credentials
2031
If you use the GitHub Perceval backend with no credentials, you'll have basic access to the GitHub API. The main difference with using authenticated use is the rate limit: a much more stringent rate limit \(number of requests to the GitHub API\) will be applied by GitHub. In any case, this basic access is very simple, since it requires no user, password or token. For example, for accessing tickets and pull requests in the Perceval repository:
2132

0 commit comments

Comments
 (0)