search

oceanhackweek / ohw20-proj-marine-heat-waves

project code for marine heat waves
Apache License 2.0
9 stars 10 forks source link

Add tests and continuous integration (CI) #4

Open Thomas-Moore-Creative opened 4 years ago

Thomas-Moore-Creative commented 4 years ago

Add tests and continuous integration (CI)

This issue might best be addressed starting with getting Trond(spelling?) to give the team a tutorial.

A key outcome of extensive testing should be clarity and confidence that refactored code or package produces identical output to https://github.com/ecjoliver/marineHeatWaves

ocefpaf commented 4 years ago

I'm happy to help with boilerplate packaging and testing if you'all need any help. See https://github.com/ioos/ioos-python-package-skeleton for some tips on what we do for IOOS packages.

Thomas-Moore-Creative commented 4 years ago

As usual, thanks @ocefpaf for your generous support. I'm still very much a git noob and know very little about CI, but will have a look at the skeleton and maybe check in with you on steps to take next?

Thomas-Moore-Creative commented 4 years ago

@ocefpaf - super basic question. What approach should I take to add CI to an under development repo? Do I make a branch for adding CI and then PR that to merge back to dev?

Thomas-Moore-Creative commented 4 years ago

to be more clear, how do I use a "template" like https://github.com/ioos/ioos-python-package-skeleton AFTER a repo is already setup and under development. My first guess is:

  1. Make a branch for the issue, see: https://github.com/oceanhackweek/ohw20-proj-marine-heat-waves/tree/Issue4-add-CI-and-tests
  2. Backfill the template codes manually with git cp commands?

Or is there a smarter way? Thanks for your expertise and assistance.

ocefpaf commented 4 years ago

There is not a smarter way. Working on a branch for that is fine. Note that you probably don't need everything in that skeleton right now. (Although as I look at the code here it is aquite advanced already!)

You'll probably need:

I would leave for later everything else, like package publishing, style and pre-commit checks, etc. Although the latter is nice to enforce as soon as possible in a project it would bring more headaches than it is worth here at the moment (a lot of unnecessary code churn).

ocefpaf commented 4 years ago

@Thomas-Moore-Creative feel free to ping me on the PR or, if you want, let me know and I can start one for you.

Thomas-Moore-Creative commented 4 years ago

@Thomas-Moore-Creative feel free to ping me on the PR or, if you want, let me know and I can start one for you.

Thanks @ocefpaf - I'll follow your advice above and then sub a PR that pings you.

Thomas-Moore-Creative commented 3 years ago

back on this issue. working on this branch - https://github.com/oceanhackweek/ohw20-proj-marine-heat-waves/tree/Issue4-add-CI-and-tests to do: