pharmaR / regulatory-r-repo-wg

Package consensus for regulated industries
https://pharmar.github.io/regulatory-r-repo-wg
27 stars 3 forks source link

add contributing guidelines to repo #20

Open kkmann opened 1 year ago

kkmann commented 1 year ago

How are we ensuring open and transparent communication? We currently, organize everything on github. The advantage is that we have a single place for finding stuff. Need to make sure this is not impeding less git-savy people from participating. Love the idea of meeting minutes with action items as issues; nice an traceable!

dgkf commented 1 year ago

how do we make the calls open? If we stick with google, could we make the calls public on GH in advance? Consider jitsi meet https://meet.jit.si/ as open alternative?

I have no problem finding something more transparent than Google Meet.

If we want to really embrace open source, I'd jump to using matrix + jitsi. I've only used matrix chat clients for text communication for other code projects, but I tested out their jitsi integration today and it seemed reasonably straightforward to set up. That could be a nice way to consolidate chat and videoconferencing if we want to go in that direction.

Do we keep materials (slides, ...) on GH as well or do we need a file repository? Slight preference for all in this repo to keep it completely open.

Either way is fine by me. I had originally thought of this as a primarily code repository, but we can always break that off when we get there and keep this repo for more administrative stuff.

kkmann commented 1 year ago

Kill GH discussions and keep it all in good 'ol github issues. All materials on GH, ideally markdown based.

kkmann commented 1 year ago

@dgkf I'd disable the discussion feature entirely just to make sure. I dont't think there is anything that needs to be salvaged from there. Maybe give it until end Jan or so?

dgkf commented 1 year ago

Yeah, sounds good. I'll keep it around for a bit in case anyone feels passionately about keeping discussions, but I'm happy to consolidate things. I agree that right now it's ambiguous and we should commit to one or the other.

kkmann commented 1 year ago

Did you consider using the 'projects' feature for keeping track of things and milestones instead of the README.md?

dgkf commented 1 year ago

I hadn't at the time since the README was a separate document to draft an initial scope - even before we had a repo set up. When we (the R Val Hub) decided we wanted to kick off the project, I just grabbed the document to get the ball rolling.

I think that would make a lot of sense to shuffle it somewhere else where it can be used more directly for project management.

I've only ever used the legacy GitHub projects. If you have experience with the new version and think it would fit well in there, Let me know and I'll add you as a maintainer to get that set up.

kkmann commented 1 year ago

x) I fear I never made it past the milestones mark. Would have to look into it as well. Maybe just give it a try and see whether it adds value? Has to be done on the pharmaR level, right?

dgkf commented 1 year ago

Just a quick follow-up. At #30 we decided that the split between issues and discussions isn't needed if we want to use this repo primarily as a project-tracking space.

I'm going to transfer all existing discussions to issues and disable the discussions part of the repo.

dgkf commented 1 year ago

And just to work toward closing out the action items on here, regarding this one:

add contribution guidelines with detailed description of set up and how to get engaged. Link in the README.md, and as a pinned issue / discussion item

I say we either put together a crude version for now, or split this off to a separate issue (possibly connected to a website like we were proposing on our #30 call?). What do you think @kkmann?

dgkf commented 1 year ago

Alright, all discussions have been moved to issues. I still need to migrate the actual content of the discussions in addition to just the initial post.

kkmann commented 1 year ago

@Crosita @dgkf could you maybe sketch up some contribution guidelines?

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

I don't think there is anything planned in terms of making the calls more open than just getting in touch via email, right? Then we can strike that point as well and close this.