Add draft github pull-request template

leifdenby commented 3 weeks ago

The aim of this PR is to add a pull-request template for use on github when add pull-requests to the common repo. The aim of my initial commit is to start the discussion on how we would like pull-requests to progress when collaborating on neural-lam.

As you will see from the template I have created so far the aim is to:

create placeholders for the PR creator to add context so we know what the PR is for
detail the steps of getting the PR reviewed and merged into the repo

Looking forward to hearing your thoughts all :)

Here's a direct link so you can see it rendered: https://github.com/leifdenby/neural-lam/blob/maint/add-github-pr-template/.github/pull_request_template.md

SimonKamuk commented 3 weeks ago

Great idea with the template, and good suggestions by @sadamov. I have just added a small comment above, and have no further changes - great work!

leifdenby commented 2 weeks ago

I am going to promote this to an actual PR from a draft PR now the discussion is well underway :smile:

joeloskarsson commented 5 days ago

Any updates on this @leifdenby? Are there specific points you want more input on? Out of my points it is mainly the checkbox for adding tests that requires some further discussion. It would be good to try to merge this soon.

mllam / neural-lam

Add draft github pull-request template #53