# Pull Request Template Explanation

## Explanations

### **Good Title:**

Use the Issue Number and the issue title for the title of your PR.

### **Description**

Add a good description here. Use the issue description to inform your own understanding of this issue. See [How to prepare a Pull Request](/wazi-ng-technical/development-process/how-to-prepare-a-pull-request-for-review.md)

### **Related Issue**

Create a link to the related Trello Card here. So that it can be easily referenced.

### **How to test it locally**

Explain how you tested the changes locally and made sure that the PR does what you intend to. \
For example if you working on Frontend Code describe which page you should open and what steps to take to see the changes you made.\
For the backend, which endpoint to hit with which params, best to provide an example like a curl command.

### **Screenshots**

If on FE, upload the desired outcome (design) and create a Screenshot, once you complete your work. Even better create a gif which shows how it works.

### **Changelog**

Create a detailed changelog, if possible. This changelog can be informed by the commits you create (reference the commit part in the git handbook). They should contain parts that you changed. This can be a bullet list, no need to create full sentences. Should be functions, classes, API Endpoints, etc.

**Added**\
What has been added.

**Updated**\
What has been updated.

**Removed**\
What has been removed.

### **Checklists**

This part should be checked off accordingly, when you're ready.


---

# Agent Instructions: 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:

```
GET https://openup.gitbook.io/wazi-ng-technical/development-process/pull-request-template-explanation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.