Skip to content

chore: implement standardised PR template for project standards#78

Open
anaghwadhwa123 wants to merge 9 commits into
thoth-tech:mainfrom
anaghwadhwa123:chore/formalise-pr-template
Open

chore: implement standardised PR template for project standards#78
anaghwadhwa123 wants to merge 9 commits into
thoth-tech:mainfrom
anaghwadhwa123:chore/formalise-pr-template

Conversation

@anaghwadhwa123
Copy link
Copy Markdown

@anaghwadhwa123 anaghwadhwa123 commented May 4, 2026

Description

This PR introduces a formal GitHub Pull Request templated located in .github/pull_request_template.md. The goal of this change is to standardise the contribution workflow across the doubtfire-astro repository, ensuring that all code and documentation updates meet our professional open-source and project standards.

Key improvements:

  • Added a dedicated section to link Microsoft Planner cards, ensuring every code change is mapped to an authorised project task.
  • Included a specific checklist item for updating the lastUpdated and author frontmatter in Markdown files, supporting our initiative for better documentation tracking.
  • Integrated a multi-browser testing checklist (Chrome, Safari, Firefox) to ensure UI consistency across the platform.
  • Formalised the requirement to request reviews from other peers, fulfilling our project standards.

Type of change

  • Documentation (update or new)

How Has This Been Tested?

  • Used the VS Code Markdown Preview (Ctrl+Shift+V) to confirm that all checkboxes, headers, and comment blocks render correctly according to GitHub Flavoured Markdown (GFM) standards.
  • Confirmed the file is located in the .github/ root directory, which is the required convention for GitHub to automatically detect and apply the template to new Pull Requests.
  • Manually verified that the [ ] syntax correctly generates interactive checkboxes that can be toggled once the PR is live.
  • Performed a local git status and diff to ensure no unintended files were modified and that the file permissions are correct for the repository.

Testing Checklist

  • Tested in latest Chrome
  • Tested in latest Safari
  • Tested in latest Firefox

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

@netlify
Copy link
Copy Markdown

netlify Bot commented May 4, 2026

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit 9086f58
🔍 Latest deploy log https://app.netlify.com/projects/ontrackdocumentation/deploys/69f839192065b2000860cf72
😎 Deploy Preview https://deploy-preview-78--ontrackdocumentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@anaghwadhwa123 anaghwadhwa123 changed the title Chore/formalise PR template chore: implement standardised PR template for project standards May 4, 2026
Copy link
Copy Markdown
Contributor

@jmirchh75 jmirchh75 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good changes, will help with new contributors submitting a PR for the first time too. Document looks cleaner and easier to read too, and additions in the checklist are useful.

@Roeenk27
Copy link
Copy Markdown
Contributor

Roeenk27 commented May 6, 2026

Good stuff, a proper PR template was definitely needed, and this one covers the right bases. The Planner card and frontmatter checklist items are nice touches.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants