search

thegreenwebfoundation / co2.js

An npm module for accessing the green web API, and estimating the carbon emissions from using digital services
Other
385 stars 48 forks source link

Create contributing.md #166

Closed fershad closed 11 months ago

fershad commented 1 year ago

This PR adds the following new files to this project repository.

This addresses #165

fershad commented 1 year ago

@mrchrisadams could you review the contents of both documents & let me know if any changes are required before merging.

mrchrisadams commented 12 months ago

Thanks for this @fershad - this appears to be based on the 1.4 version of the Contributor Covenant, and there's new version out - was there a deliberate decision to choose the 1.4 variant?

Here's the 1.4 version - https://www.contributor-covenant.org/version/1/4/code-of-conduct/

Here's the newest 2.1 version - https://www.contributor-covenant.org/version/2/1/code_of_conduct/

I've looked over 2.1, and I'm comfortable with using either, but 2.1 seems to offer two things that might I think are improvements:

  1. more clarity about escalation
  2. being less specific about contact channel (1.4 says [INSERT EMAIL ADDRESS], and 2.1 says [INSERT CONTACT METHOD])

Escalation path

Also, this bit here:

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS].

I think we'll need to add an email address in the CoC.

It took me about a minute to set up code_of_conduct@thegreenwebfoundation.org, which we can use, and for the time being I've set this up to send messages to me. I work full time for the foundation, and at least that way there's an escalation path until we decide a more involved process.

Finally, before we merge this in, can you please take a few minutes to see if it makes sense to create these docs at the root level of the org, so it cascades through all our projects? I think github supports defining a document or template at the organisational level, which then becomes the default for all projects, but I've never implemented it before myself.

If it's not easy to find this out, we can always create a new issue to research this so we can get this merged in just for this project. - ll leave it to you to decide about which route makes more sense.

fershad commented 11 months ago

Thanks @mrchrisadams. I've found out how to create organisation wide defaults for Code of Conduct, Contribution & Funding. https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

We can override these in individual repos as required, but for now I'll use the content of these documents (updated Code of Conduct to 2.1) for the org-wide defaults.

fershad commented 11 months ago

Files created for organisation in https://github.com/thegreenwebfoundation/.github