Skip to content

Instantly share code, notes, and snippets.

@PatrickNiyogitare28
Last active December 26, 2021 15:48
Show Gist options
  • Save PatrickNiyogitare28/ace013046d0814b2321a1a4322f07b00 to your computer and use it in GitHub Desktop.
Save PatrickNiyogitare28/ace013046d0814b2321a1a4322f07b00 to your computer and use it in GitHub Desktop.

Basic stardard description of a Pull Request

Hi folks 🖐! I'm sharing the template of describing your PR. Most of the time people describe Pull requests in their way but the thing is that there is a stardard way of PR description, what I'm sharing today is a basic template of PR description. You can folk this out or copy to be used in your PR description. Thank you.

Mackdown

#### What does this PR do?

- Implements add a todo task

#### Description of Task to be completed? 

- User can be able to add a todo task

#### How should this be manually tested?

- Clone the repo

- checkout to branche ``fit-create-todo``

- Run `npm install` to install modules

- Run `npm  run start` to start the development server

- In your API testing tool (postman recommended) call api `localhost:5000/api/tasks/addTask` to add a todo task

#### Any background context you want to provide?

- Note that you should send the request with a valid auth bearer token
- request body 
 ``{
     taskName: "Reading"
   }
  ``

#### What are the relevant Pivotal Tracker/trello stories?

- link to my pivotal tracker/tello/jira ... implemented story

#### Screenshots (if appropriate)
- upload the screenshot if available or N/A if not available

#### Questions:

- Add question if available or N/A if not available

Preveiw

What does this PR do?

  • Implements add a todo task

Description of Task to be completed?

  • User can be able to add a todo task

How should this be manually tested?

  • Clone the repo

  • checkout to branche fit-create-todo

  • Run npm install to install modules

  • Run npm run start to start the development server

  • In your API testing tool (postman recommended) call api localhost:5000/api/tasks/addTask to add a todo task

Any background context you want to provide?

  • Note that you should send the request with a valid auth bearer token
  • request body { taskName: "Reading" }

What are the relevant Pivotal Tracker/trello stories?

  • link to my pivotal tracker/tello/jira ... implemented story

Screenshots (if appropriate)

  • upload the screenshot if available or N/A if not available

Questions:

  • Add question if available or N/A if not available

Hope that was helpful

#gitPractices #git

Twitter Badge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment