LDAR-Sim / LDAR_Sim

MIT License
11 stars 22 forks source link

Add pull request template #69

Closed ThomasGalesloot closed 1 year ago

ThomasGalesloot commented 1 year ago

Pull Request Key Information

Reason for change

As part of an initiative for cleaner LDAR-Sim development process, we are looking to make Pull Requests more consistent.

What was changed

Added a Pull Request template, following GitHub documentation

Intended Purpose

The purpose of this change is to have developers for LDAR-Sim use the pull request template going forwards.

Level of version change required

N/A

Testing Completed

No testing completed. Markdown was previewed using a VS Code extension. Pull request template will only take effect once it is part of the main branch.

Target Issue

N/A

Additional Information

Brief research indicates that Pull request templates cannot be yml forms like GitHub issues and must instead be in the markdown format

ThomasGalesloot commented 1 year ago

Will there ever be a need for alternative pull request templates? I cannot think of a scenario where there would be a need for an alternative template as this current one covers everything. However, if you can think of a scenario where an alternative template would be required, I would like to suggest adding this to .github/PULL_REQUEST_TEMPLATE directory instead of just the .github directory.

The reason why I did not add the pull request template to the PULL_REQUEST_TEMPLATE directory is that I understood the documentation to mean that adding the template to that directory would not always results in it being used. I think if we want multiple templates in the future, the template should be moved to the PULL_REQUEST_TEMPLATE directory as part of that change.

SEAJang commented 1 year ago

Will there ever be a need for alternative pull request templates? I cannot think of a scenario where there would be a need for an alternative template as this current one covers everything. However, if you can think of a scenario where an alternative template would be required, I would like to suggest adding this to .github/PULL_REQUEST_TEMPLATE directory instead of just the .github directory.

The reason why I did not add the pull request template to the PULL_REQUEST_TEMPLATE directory is that I understood the documentation to mean that adding the template to that directory would not always results in it being used. I think if we want multiple templates in the future, the template should be moved to the PULL_REQUEST_TEMPLATE directory as part of that change.

That makes sense.