Add CI as a of project template

[Dhananjhay]

Proposed changes

Describe the changes implemented in this pull request. If the changes fix a bug or resolves a feature request, be sure to link the issue (and explain how the changes address the issue). Be sure to select a label describing the PR (e.g. maintenance).

Main theme: Add Continuous Integration (CI) pipeline using GitHub Actions in the project template for poetry package manager.

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

• [ ] Changes have been tested to ensure that fix is effective or that a feature works.
• [ ] Changes pass the unit tests
• [ ] I have included necessary documentation or comments (as necessary)
• [ ] Any dependent changes have been merged and published

Notes

All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

[pvandyken]

@Dhananjhay Are you still working on this? We have discussed this in the past, I was hesitant to introduce too many things into the basic template, especially since test workflows are going to vary so much (e.g. should we still use black and isort??).

[Dhananjhay]

Hey @pvandyken! I started working on this a few weeks ago but it's been a minute since I looked at this feature/PR. It seems to be pretty outdated (we want to move towards using pixi and this PR still works with miniconda...). I think the idea was introduce users to boilerplate CI pipelines but I agree on the concept of keeping things simple. Happy to discuss this further with you and @akhanf.