FAST-HEP / fasthep-flow

Convert YAML into a workflow DAG
Apache License 2.0
1 stars 1 forks source link

Docs on CONTRIBUTING #18

Open YeungOnion opened 8 months ago

YeungOnion commented 8 months ago

Not sure how many others we'll be reaching who'll contribute, but I think it would be a good exercise for me to ensure I'm using the same dev environment (or as much as possible) and that I'm on the same page by writing some contribution documentation.

I see to use hatch, and I'll get that via pipx, but what's your development workflow look like and how does that connect to the user workflow - I ask since most contributors will be both.

I imagine that unit testing at this point won't need full workflows, but do we want to use the CMS public example as the "tracer bullet" for a newcomer into interact with the major parts of the workflow (and file links to current implementations) for onboarding?

kreczko commented 8 months ago

You are right, the current docs are a bit vague: https://fasthep-flow.readthedocs.io/en/latest/installation.html

I've started to draft something, but it never saw the light of day - I will try to put some effort here

My workflow is

but do we want to use the CMS public example as the "tracer bullet" for a newcomer into interact with the major parts of the workflow (and file links to current implementations) for onboarding?

No, CMS public example is the first "full" example, but it should not remain the only one:

Jim Pivarski had always some good non-HEP examples that are suitable for the "in between" examples:

That said, for the purpose of "phase 0-2", the first list is more than enough. If you have any other ideas for "in between", please let me know.

@seriksen @m-glowacki Do you have any preferences?