Open thogar-computer opened 2 years ago
so turns out that PR cannot be done in the same format as the templates for Issues and Bugs
Therefore this is a markdown template based heavily on https://github.com/ionic-team/ionic-framework/blob/main/.github/PULL_REQUEST_TEMPLATE.md with a few changes/extras added
it might seem a little much, I think for the moment better to be heavy-handed and gather lots of information than too little
Intro
There is a checklist of items that GitHub has picked as 'good practice' for Open Source projects to follow;
https://github.com/British-Oceanographic-Data-Centre/COAsT/community
we have some of these already and it would be good to get a full house
User Story
As a developer, I want consistency when working on pull requests so that there is less time spent on understanding the request and more time given to reviewing the work.
Given the COAst (and COAsT-site) repo are public and open to all When a new contributor joins And requests their work to be included in the codebase Then there should be a defined and consistence work practice
Details
GitHub allows for Pull Request to be built off a template https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
This will help in keep a consistency to the PR/MR process as the community grows
AC
This ticket is done when there is at least one PR template for the COAsT and COAst-site repo.