Create CONTRIBUTING.md - Githubissues

ioos / ioos_qc

:ballot_box_with_check: :ocean: IOOS QARTOD and other Quality Control tests implemented in Python

https://ioos.github.io/ioos_qc/

Apache License 2.0

42 stars 27 forks source link

Create CONTRIBUTING.md #103

Closed MathewBiddle closed 3 weeks ago

MathewBiddle commented 4 months ago

It would be beneficial if there was guidance for how folks can contribute to this repository.

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

I am willing to take a stab at it so it's not starting from a blank slate.

ocefpaf commented 4 months ago

@MathewBiddle not sure if you already have something in mind but here are my two cents:

The metpy contributing docs are great and we could steal some of their text;
Maybe we could create something that applies to all IOOS projects.

MathewBiddle commented 4 months ago

I like the idea of 2, but I wonder about the feasibility. If you don't mind drafting some content, I can take a look.

Initially I was going to copy https://github.com/ioos/bio_mobilization_workshop/blob/main/CONTRIBUTING.md and update the Where to contribute section.

kbailey-noaa commented 4 months ago

I'm interested in this for the glider-dac repo.

ocefpaf commented 4 months ago

Initially I was going to copy https://github.com/ioos/bio_mobilization_workshop/blob/main/CONTRIBUTING.md and update the Where to contribute section.

That is kind of aimed at documentation text. The one I mentioned has a bit more on how to clone, run tests, report bugs, etc. See https://github.com/Unidata/MetPy/blob/main/CONTRIBUTING.md

I'm interested in this for the glider-dac repo.

I can send a PR with a modified version to https://github.com/ioos/.github and we can add links to it from the various IOOS repo. (I'm not sure if that propagates like the issue/PR template.)

MathewBiddle commented 4 months ago

I can send a PR with a modified version to https://github.com/ioos/.github and we can add links to it from the various IOOS repo. (I'm not sure if that propagates like the issue/PR template.)

sounds good to me. At least it will provide a place to copy from at a minimum.

ocefpaf commented 4 months ago

Done in https://github.com/ioos/.github/pull/9

MathewBiddle commented 3 months ago

@ocefpaf that contributing guide doesn't appear in this repository. Should we just copy it from https://github.com/ioos/.github/blob/main/CONTRIBUTING.md ? Or is there a way to point to our org contributing guide?

ocefpaf commented 3 months ago

@ocefpaf that contributing guide doesn't appear in this repository. Should we just copy it from https://github.com/ioos/.github/blob/main/CONTRIBUTING.md ? Or is there a way to point to our org contributing guide?

I guess we have to link it in the README or copy it over. I could not find any special treatment on GH's part for this but I recall there are open issues to requesting it.

Sakshamgupta90 commented 1 month ago

I guess we have to link it in the README or copy it over. I could not find any special treatment on GH's part for this but I recall there are open issues to requesting it.

Hi @ocefpaf Is it fine if I refer to https://github.com/ioos/.github/blob/main/CONTRIBUTING.md and https://github.com/Unidata/MetPy/blob/main/CONTRIBUTING.md, and copy the relevant information?

ocefpaf commented 1 month ago

You can start by copying https://github.com/ioos/.github/blob/main/CONTRIBUTING.md and modify it to be more "ioos_qc" specific.

ocefpaf commented 3 weeks ago

Done in #120.