freesurfer icon indicating copy to clipboard operation
freesurfer copied to clipboard

community standards

Open PeerHerholz opened this issue 4 years ago • 26 comments

Hi gang,

I think we should add a CoC and contributor guidelines to make it easier for new folks to become an active part and ensure community standards. Looking around a bit, fmriprep's version(s) would be great to adapt from. WDYT @Shotgunosine?

PeerHerholz avatar Jun 26 '20 19:06 PeerHerholz

Yeah, that sounds good to me!

Shotgunosine avatar Jun 30 '20 14:06 Shotgunosine

Cool. I think this would be great first issue for a new contributor. Should we post it somewhere to see if someone wants to tackle it?

PeerHerholz avatar Jun 30 '20 15:06 PeerHerholz

Sure, we can see if we get any takers.

Shotgunosine avatar Jun 30 '20 15:06 Shotgunosine

Would Virtual Brainhack CoC help you by any chance as a starting point? You can check it from here https://docs.google.com/document/d/11aE6vv67i9pzOUN7DTypqiAVUutXAijP7_jZTURHhAM/edit?usp=sharing

complexbrains avatar Jun 30 '20 16:06 complexbrains

Hi again, if no one is assigned for this issue, me and @anibalsolon can work on that! We worked on the Brainhack one together with @anibalsolon and he also shared several examples of CoCs written for well known open source projects with me today. So we can come up with something based on all those if that is fine with you all! Also if there is anything in your mind or you know any other examples that you want us to go through please do not hesitate to share!

So please feel free to assign the CoC work to both of us 🤗 Thank you!

complexbrains avatar Jun 30 '20 18:06 complexbrains

Cool, thx a lot @complexbrains and @anibalsolon. So far we have no other interests, thus no need for discussing who's taking it. I think the link you share + the links I mentioned above are good starting points, as we would have some consistency with other packages but maybe update them a bit.

PeerHerholz avatar Jun 30 '20 18:06 PeerHerholz

Hi gang, I renamed the issue to "community standards", as I think we could summarize those that are currently missing in the repo:

  • [ ] code of conduct
  • [ ] contributing guidelines

Please feel free to propose others as well.

PeerHerholz avatar Jul 01 '20 02:07 PeerHerholz

Hi all! @complexbrains and @anibalsolon, I am interested in helping out on this issue, so let me know if there is anything I can do! Thanks!

lilyeisner avatar Jul 01 '20 14:07 lilyeisner

Hi @lilyeisner,

thank you very much for your interest to help out. @complexbrains and @anibalsolon are amazing folks and I'm sure y'all will do a great job together!

PeerHerholz avatar Jul 02 '20 19:07 PeerHerholz

Hi @lilyeisner, for sure there is! The more the merrier, it is always good to have a new set of eyes over these documentations. Thank you @PeerHerholz for the introduction :v:

To be honest, we did not start yet, but we should soon. If you have any ideas or sources that you think we should be going over together, please share it with us! We will share a doc here for the basic skeleton as soon as possible. Does it seem good? Also, if you want to start going over the fMRIPrep contribution guidelines, it would be nice! They surely did a great job there.

anibalsolon avatar Jul 03 '20 14:07 anibalsolon

Thanks @anibalsolon! That sounds like a great plan. I have read through the fMRIPrep contribution guidelines and code of conduct as well as the Would Virtual Brainhack CoC posted by @complexbrains above. These all look like great places to start and I am looking forward to seeing the basic skeleton and adding information from there! Thanks again for including me!

lilyeisner avatar Jul 06 '20 16:07 lilyeisner

Dear @lilyeisner so sorry late reply, I had the sources open in my tabs for days but just found time to go over them 😞 but thank you very much for the offer of your help and contributions 🤗

So here is the first draft of the contribution guideline I came up with via going through several contribution guidelines which are listed in the References. It seems like it is a common application to fork the guideline from each other and specify as necessary, so this is what I did here too.

But there are still standing bits and pieces need clarification and also maybe some points needs to be added/removed. So I was thinking maybe it would be nice if @PeerHerholz and @Shotgunosine could go over the guideline too, and gives us recommendations, so we can continue.

Please do have a look at the document and do not hesitate to make any amendments/additions as you see necessary. And contact to me if there is any need for help or explanation regarding the document.

After we are all sure with the format and content we will convert it to and .md file and it's done!

Thank you very much in advance🤗

complexbrains avatar Jul 08 '20 20:07 complexbrains

Hi @complexbrains, The document you linked mentioned the code of conduct, is there a draft of that somewhere as well? In terms of a development model, I work from a locally built docker container, if we put in instructions on how to do this, is that an ok way to have people work?

Shotgunosine avatar Jul 09 '20 15:07 Shotgunosine

Hi @Shotgunosine I guess @anibalsolon is on CoC, we should be finalizing the first draft at the weekend I believe, and share.

Regarding the docker container, actually I believe it would be nice to give such basic instructions regarding setting up the whole environment from scratch or at least pointing to the right sources regarding how to do it. Would like to add such inputs based on your experiences please then we can go over together if you want? Let me know if it sounds ok for you please. Thank you!

complexbrains avatar Jul 09 '20 16:07 complexbrains

@lilyeisner can put in the basic instructions for getting docker running and I'll add notes to that.

Shotgunosine avatar Jul 09 '20 16:07 Shotgunosine

Hi gang,

I just did a first read through of the contributing guidelines and they're fantastic , great job @complexbrains, @lilyeisner. @anibalsolon and @Shotgunosine. It appears that the main thing that is missing is the docker related build and test fun, eh?

PeerHerholz avatar Jul 18 '20 17:07 PeerHerholz

Hi all,

I've worked a CoC based on the Contributor Covenant and the Django CoC, so please if you have some time to review it:

https://hackmd.io/@anibalsolon/BJyg5r0R8/edit

One thing to decide is about enforcement, on who (at least 2 people) would be the contact point for it.

Also, the Mozilla community has a great guideline about participation: https://www.mozilla.org/about/governance/policies/participation/ I believe we should not extend much, but it is a good source to review.

Please let me know what you think, and add your considerations to the doc.

anibalsolon avatar Jul 19 '20 16:07 anibalsolon

@PeerHerholz It looks like the docker instructions in there are pretty good. I added a few more details, let me know what you think.

Shotgunosine avatar Jul 20 '20 17:07 Shotgunosine

@anibalsolon I think the CoC looks good. I think @PeerHerholz should be one of the contact points. Are there any other volunteers?

Shotgunosine avatar Jul 20 '20 17:07 Shotgunosine

Ah, sorry, completely missed this. I checked the docker sections and think they're already pretty great. I added some pointers/questions that mainly serve clarification. IMHO everyone of the fantastic folks here could be a contact point. However, of course only if you want to/feel like it!

PeerHerholz avatar Aug 03 '20 23:08 PeerHerholz

Hi folks,

just wanted to ping y'all to see where we are with this. @anibalsolon, @complexbrains, @lilyeisner.

PeerHerholz avatar Oct 16 '20 01:10 PeerHerholz

Hi @PeerHerholz thank you for the ping and sorry for the delay in that . I guess there were some technical aspects you and @Shotgunosine raised to be addressed and we were lacking several contact point information from the contribution guideline. I might be in short of completing the technical aspects but will check if I can help with anything else. I will also go over the CoC and see if I can adapt anything from the one we created with @anibalsolon and @SamGuay for the BHG.

complexbrains avatar Oct 16 '20 11:10 complexbrains

yeah, I'm happy to sever as a contact point.

Shotgunosine avatar Oct 19 '20 17:10 Shotgunosine

@PeerHerholz, @Remi-Gau, @complexbrains @anibalsolon @lilyeisner. Just coming back to this after working on the Freesurfer 7 build. I know it's been 3 years, but are there any changes left to make for this? Could we go ahead and add them?

Shotgunosine avatar Aug 30 '23 21:08 Shotgunosine

Note that in terms of CoC you are bu default using that of the bids app organization if your repo does not have one:

https://github.com/bids-apps/.github/blob/main/CODE_OF_CONDUCT.md

Remi-Gau avatar Aug 30 '23 22:08 Remi-Gau

Hi folks,

thx @Shotgunosine and @Remi-Gau for working on the FreeSurfer 7, that's great!

Re the changes/files: yeah, let's do it!

PeerHerholz avatar Aug 31 '23 13:08 PeerHerholz