Add a How to contribute page

OpenTermsArchive / docs

User documentation website for Open Terms Archive

https://docs.opentermsarchive.org

Creative Commons Attribution Share Alike 4.0 International

1 stars 3 forks source link

Add a How to contribute page #67

Open Cli4d opened 1 year ago

Cli4d commented 1 year ago

Problem Statement

Currently, there are no concrete instructions to potential contributors on how and where they can make their contributions.

Additional Information

The GitHub organization currently has no directions as to how one can make contributions to Open Terms Archive

What happens if this is not addressed

If no directions are given on contributing, we will lose potential contributors and also have no organization on how to onboard and manage the existing contributors

Potential solutions

Draft a contributing file to give directions to new contributions on how to get started making contributions to Open Terms Archive
We then pin this file in the Open Terms Archive organization and preferably provide similar instructions on the Open Terms Archive website

emmanuellar commented 1 year ago

There's a contributing.md file here I believe we can make some improvements to it, just thought to share with you in case you missed it.

I'll add

This 'how to contribute' doc should also consist of the first action item for new or potential contributors. Eg, what is the first thing we want a new member to do on visiting the website? - Join our community?, check out our GitHub?, Read through our documentation?, Try out Open Terms Archive? Check our impact? This will form the basis of a potential review of the Call to Action link on the homepage of the website which currently leads to the Impacts page.

Cli4d commented 1 year ago

Hi @emmanuellar I've had a look at the link you shared and I think that is their code of conduct. But I did find the contributing file here

Cli4d commented 1 year ago

Hi @emmanuellar I've had a look at the link you shared and I think that is their code of conduct. But I did find the contributing file here

Cli4d commented 1 year ago

Not sure where to move this issue. It is similar to the one opened here

Cli4d commented 1 year ago

@MattiSG I think this issue can be transferred to the repo template declarations. I think it fits in there

MattiSG commented 1 year ago

Thanks @Cli4d for this research and suggestion!

From what I understand of this issue, there is one part related to describing the overall contribution possibilities and processes. That one should indeed lead to a dedicated page on the docs. Another part should be about making it clear to contributors to specific collections how they can add JSON files to track more terms.

The second one is already opened on https://github.com/OpenTermsArchive/template-declarations/issues/32. I would thus suggest transferring this issue to https://github.com/OpenTermsArchive/docs/issues and renaming it to something like “Describe contribution opportunities and processes” 🙂 If that does not seem right to you, please feel free to suggest an alternative!