Add draft github pull-request template

[leifdenby]

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

[sadamov]

Thanks, this will prove very useful! I added some smaller discussion points.

[sadamov]

Suggested change

	- [ ] the code readable
	- [ ] the code well tested
	- [ ] the code documented
	- [ ] the code easy to maintain
	- [ ] the code is readable
	- [ ] the code is well tested
	- [ ] the code is documented
	- [ ] the code is easy to maintain

[sadamov]

Is it clear how to test "easy to maintain"? Maybe we should be a bit more specific here (e.g. modular, using existing open-source libraries, ...)

[joeloskarsson]

Yes, I think most of these can be expanded on and made more concrete. But that then turns into more of a coding style guide, that probably fits better somewhere else (related to my other comment).

[leifdenby]

we can also leave "easy to maintain" out? The other three cover this some degree and this isn't explicit enough about how we measure this that the comment is probably superfluous

[leifdenby]

I will remove "easy to maintain" since that is hard to measure objectively, we can always adapt this template later if we find it is missing something or doesn't quite work :)

[SimonKamuk]

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!

[joeloskarsson]

Yes, I think most of these can be expanded on and made more concrete. But that then turns into more of a coding style guide, that probably fits better somewhere else (related to my other comment).

[leifdenby]

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

[joeloskarsson]

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.

[leifdenby]

TODO

• remove line about having added tests
• add option for documentation under the type of change
• update changelog sections to choose from to be explicitly listed as added, changed, fixed, maintenance

[leifdenby]

Ok, I think this is ready to go now @joeloskarsson. Do you mind giving it a last read over?

[joeloskarsson]

Gave it a proofread and fixed some grammar. After these fixes + updating the docstring text this should be good to merge imo!

[leifdenby]

Thanks for the thorough review @joeloskarsson!

[leifdenby]

This just needs your approval and then I will merge in :)

[joeloskarsson]

Great, all looking good now!