Template feedback - Githubissues

peterdudfield commented 1 month ago

Great work @devsjc on the tempate, I really like it

Few minor points

It would be great if the contrbutors could work with https://allcontributors.org/. I think its important to give people credit for the work they have done, and this tool makes it nice and easy for us to manage
Could we add a Q&A section, for FAQ. Some repos wont have it, but some definitely will
Could we add tests - passing or not, as a badge
Could we emphasis the examples for the pip install library's, so they dont need to do any git cloning
Should issue open badge go near the top? Keep it all up there
Could your center the badges, like you did in dagster-dag
Could you add ssection, could be in the dvelopment bit, of "how to run tests" - personally i think its good to make this really clear

devsjc commented 3 weeks ago

Thanks @peterdudfield, lots of good suggestions! Added most of it in https://github.com/openclimatefix/ocf-template/commit/18034859b72367855f522d6ea7a2df64cd56d2f2, except the following:

Could we add tests - passing or not, as a badge

That's the first badge, the actions workflows one. Will need editing to point to the correct pipeline in the repo, the label can be updated accordingly.

Could we emphasis the examples for the pip install library's, so they dont need to do any git cloning?

I tried to strongly hint to this to already in the guidance for the installation section here:

How to install the project for general use (not for development), so: "pip install x", or "pull the latest checkpoint from y", not "clone the repo and run make install".

Let me know any suggestions for further emphasis if you feel it could be clearer!

Should issue open badge go near the top? Keep it all up there

Certainly could! My reasoning for it being near the contributing "PR's welcome" section was as a low friction route: someone reading the contributing section - and thinking they might like to help - immediately is provided with somewhere for them to go to follow through with that thought instead of doing any scrolling and other thinking, and so reduces the barrier as much as possible, and feels worth the trade-off of the slight lack of neatness of not having all the badges together? Open to hear arguments against though, I obviously have no data to back this up!

Could your center the badges, like you did in dagster-dag

I think it looks a little weird without the title and subtitle text also being centred - do you want it all centred?

peterdudfield commented 3 weeks ago

Thanks @devsjc for doing all these. That all makes sense.

Centre badges and title looks good here, I thought, but happy to go with your reasoning

devsjc commented 3 weeks ago

Take a look at https://github.com/openclimatefix/ocf-template/pull/10, see what you reckon!

peterdudfield commented 3 days ago

Could we add something like this for the badges, I think it looks nice

Screenshot 2024-10-28 at 11 32 28

openclimatefix / ocf-template

Template feedback #9

Could we add tests - passing or not, as a badge

Could we emphasis the examples for the pip install library's, so they dont need to do any git cloning?

Should issue open badge go near the top? Keep it all up there

Could your center the badges, like you did in dagster-dag