🛠️
Wazimap technical handbook
  • Introduction
  • System Architecture
    • Database Models
    • IndicatorData
    • Geography Hierarchies
    • Choropleth Maps
    • Determine which instance to use
  • Development
    • Code Deployment
    • Component Architecture
    • Development Process
    • Pull Request Template Explanation
    • Code Review Process
    • Pull Request Template (FE)
    • Webflow Integration
    • Merging webflow exports
    • Rules for Webflow exports
    • Webflow exports & changelog
      • June 2023
      • March 2023
      • February 2023
      • December 2022
      • November 2022
      • October 2022
      • May 2022
      • April 2022
      • March 2022
      • January 2022
      • December 2021
      • November 2021
      • October 2021
    • Translation
    • Map components
  • Testing
    • Testing guidelines
    • Critical Paths
    • GUI Tests
    • Heroku Review Apps
  • Design
    • Iconography
  • Change Proposals
  • NGPx - Template
  • NGP1 - Changing the data model (Implemented)
  • NGP2 - Presenting Geographical Hierarchies to users
  • NGP3 - Change Geography Hierarchies
  • NGP4 - Format configuration
  • NGP5 - Multiple count columns
  • NGP6 - Profile-specific open graph metadata
  • NGP7 - Wazimap profile domain management
  • NGP8 - Replacing Webflow as frontend framework
  • Tutorials
    • Creating a new profile
    • Loading new geographies
    • Loading Data
    • Creating a new admin user
    • Creating a non-admin user for a private profile
    • Changing the Geography level name
    • Deployment to Dokku
  • Configuration
  • Profile Configuration
  • Profile Indicator Configuration
  • Profile Collection Configuration
  • Geographies, hierarchies and versions
  • API
    • General API Information
    • Upload API
    • Task Status
    • Point data API
Powered by GitBook
On this page
  • Explanations
  • Good Title:
  • Description
  • Related Issue
  • How to test it locally
  • Screenshots
  • Changelog
  • Checklists

Was this helpful?

Export as PDF
  1. Development

Pull Request Template Explanation

And explanation of the items in the Template

PreviousDevelopment ProcessNextCode Review Process

Last updated 4 years ago

Was this helpful?

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

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.

How to prepare a Pull Request