search

datasciencecampus / coding-in-the-open

A compendium of open-source guidance which aims to share the benefits, risks and a summarised strategy for open-source coding.
https://datasciencecampus.github.io/coding-in-the-open/
MIT License
8 stars 0 forks source link

PR template unformatted #40

Closed ethan-moss closed 1 year ago

ethan-moss commented 1 year ago

Describe the bug The PR template has significant formatting issues

To Reproduce

  1. Raise a PR.
  2. Observe unformatted PR template

Expected behavior

  1. PR template would be formatted, such that the checkboxes are in markdown
  2. give a clear section for a description/motivation.
  3. Unnecessary YAML pre-amble appears at the top of the file

Would recommend using an alternative PR template.

Screenshots image

Desktop (please complete the following information):

Smartphone (please complete the following information):

Additional context Add any other context about the problem here.

ethan-moss commented 1 year ago

@r-leyshon @ColinDaglish - raising this issue since the formatting of the PR template isn't correct. Not an urgent issue though, since a PR template does correctly get passed through when raising a PR.

ethan-moss commented 1 year ago

@r-leyshon, @ColinDaglish , PR #41 is now ready for review