> For the complete documentation index, see [llms.txt](https://docs.whaly.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.whaly.io/connectors/source-catalog/engineering/github.md).

# Github

## **Why syncing my Github to** [**Whaly**](https://whaly.io)**?**

Syncing your Github can be useful for various cases:

* Report on your team velocity to the rest of the team and your stakeholders
* Make sense of the time passed on each milestone
* Use labels to track the time to close of your pull requests
* Make sure that your pull requests doesn't stay stale
* ...

## Which Github data is synced by [Whaly](https://whaly.io)?

[Whaly](https://whaly.io) 🐳 is currently syncing the following data:

* **Organisation**: Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once.
* **Repository:** To put your project up on GitHub, you will need to create a repository for it to live in.
* **User:** Users are members or outside collaborators of an organization.
* **Label:** You can classify issues, pull requests, and discussions by creating, editing, applying, and deleting labels.
* **Team:** Teams are groups of organization members that reflect your company or group's structure with cascading access permissions and mentions.
* **Milestone:** You can use milestones to track progress on groups of issues or pull requests in a repository.
* **Pull Request:** Pull requests let you tell others about changes you've pushed to a branch in a repository on GitHub.
* **Pull Request Requested Reviewer Association:** Association between pull request and users requested to review.
* **Pull Request Assignee:** Association between pull request assignee aka users and pull request.
* **Pull Request Label Association:** Association between pull request & labels.
* **Pull Request Team Association:** Association between pull request and team requested to review.

{% embed url="<https://docs.google.com/presentation/d/1TIGQRve6ndKgCiTdNSBkzslggCx1zZWG2sPsZ8i4hVs/edit?usp=sharing>" %}
[You can find the details here](https://docs.google.com/presentation/d/1TIGQRve6ndKgCiTdNSBkzslggCx1zZWG2sPsZ8i4hVs/edit?usp=sharing)
{% endembed %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.whaly.io/connectors/source-catalog/engineering/github.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.