tmdinosaurcenter
/
dwc
mirror of https://github.com/tdwg/dwc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

This commit is contained in:
John Wieczorek 2021-08-06 22:47:41 -03:00 committed by GitHub
parent 076d23c48e
commit c3f281b034
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
.github/CONTRIBUTING.md vendored
View File

@ -1,73 +1,21 @@
# Guidelines for contributing # Guidelines for contributing
This document describes how you can contribute to Darwin Core. ## What can I do for Darwin Core?
Changes to the standard are subject to section 3 Change Process of the [TDWG Vocabulary Maintenance Specification](https://github.com/tdwg/vocab/blob/master/vms/maintenance-specification.md). Here's how you can contribute: Anything that makes the Darwin Core more useful, conducted with respect and understanding. Specifically, you can:
- learn more about Darwin Core and how to use it (be able to recite the [Darwin Core Quick Reference Guide](https://dwc.tdwg.org/terms/) in your sleep; take the [Sporcle Quiz](https://www.sporcle.com/games/gtucobtuco/darwin-core-terms) if you have doubts or need practice; consult the [Darwin Core Questions & Answers site](https://github.com/tdwg/dwc-qa) for additional commentary)
- seriously though, read the documentation with a critical eye and question it. If something doesn't make sense or isn't clear to you, [we](https://www.tdwg.org/community/dwc/) want to know about it
- ask about things you don't know (open an issue in the [Darwin Core Questions & Answers Issue Tracker](https://github.com/tdwg/dwc-qa/issues), or fill in the [Darwin Core Hour Input Form](https://docs.google.com/forms/d/e/1FAIpQLSekd0QSdgiK5ujh6CLZPx9kKTcS-mJRNK_pGWk3b3fHv4x4gQ/viewform?c=0&w=1), or send email to tdwg-content@lists.tdwg.org
- help to point people to the right place to get answers to their questions (you, because you are now an expert, or any of the resources described above)
- share what you do know (answer questions on the [Darwin Core Questions & Answers Issue Tracker](https://github.com/tdwg/dwc-qa/issues); create documentation for the [Darwin Core Questions & Answers Wiki](https://github.com/tdwg/dwc-qa/wiki) to explain the details of how best to use Darwin Core; respond to open [Darwin Core Maintenance issues](https://github.com/tdwg/dwc/issues)).
## How can I propose a change to the Darwin Core standard?
Changes can be proposed at any time. There are three requirements that must be satisfied in order to justify that a change be considered, the demand requirement, the efficacy requirement, and the stability requirement. Be prepared to satisfy these requirements if you want to make a change. The details of these requirements can be found in Section 3.1 Justifications for Change in the [Vocabulary Maintenance Specification](https://github.com/tdwg/vocab/blob/master/vms/maintenance-specification.md).
To initiate the change request, the preferred method is to create a new issue (https://github.com/tdwg/dwc/issues/new/choose) in the Darwin Core Issue Tracker. Use the appropriate template to create a new issue and fill it out as clearly, concisely, and completely as possible. Don't worry, if there are things you can not provide, the Darwin Core Maintenance Group will help you to develop the issue to maturity. If you can not or do not wish to use the Issue Tracker, please send the proposal in a message to tdwg-content@lists.tdwg.org.
- if you want to suggest a change to a Darwin Core term, please use the [Term change template](https://github.com/tdwg/dwc/issues/new?assignees=&labels=Term+-+change&template=term-change-template.md&title=Change+term+-+)
- if you want to suggest a new Darwin Core term, please use the [New term template](https://github.com/tdwg/dwc/issues/new?assignees=&labels=Term+-+add&template=new-term-template.md&title=New+Term+-+)
- for any other request for change to the Darwin Core standard, fill out a new [blank issue](https://github.com/tdwg/dwc/issues/new)
* Want to make a change to the standard? Copy and paste one of the **issue templates** below and [submit a new issue](https://github.com/tdwg/dwc/issues/new).
* Want to contribute to this repository? [Fork the repository](https://github.com/tdwg/dwc/fork), make the changes, and [send a pull request](https://github.com/tdwg/dwc/compare).
* Have a question about Darwin Core? Send it to tdwg-content@lists.tdwg.org or to the Darwin Core Questions & Answers repository through [this form](https://docs.google.com/forms/d/e/1FAIpQLSekd0QSdgiK5ujh6CLZPx9kKTcS-mJRNK_pGWk3b3fHv4x4gQ/viewform?c=0&w=1) or directly as a new [issue](https://github.com/tdwg/dwc-qa/issues). * Have a question about Darwin Core? Send it to tdwg-content@lists.tdwg.org or to the Darwin Core Questions & Answers repository through [this form](https://docs.google.com/forms/d/e/1FAIpQLSekd0QSdgiK5ujh6CLZPx9kKTcS-mJRNK_pGWk3b3fHv4x4gQ/viewform?c=0&w=1) or directly as a new [issue](https://github.com/tdwg/dwc-qa/issues).
## Issue templates
### New term
Copy and paste this template into your [new issue](https://github.com/tdwg/dwc/issues/new) if you want to create a term that does not exist yet ([example]()).
```
## New term
* Submitter:
* Justification (why is this term necessary?):
* Proponents (at least two independent parties who need this term):
Proposed attributes of the new term:
* Term name (in lowerCamelCase):
* Class (e.g. Location, Taxon):
* Definition of the term:
* Usage comments (recommendations regarding content, etc.):
* Examples:
* Refines (identifier of the broader term this term refines, if applicable):
* Replaces (identifier of the existing term that would be deprecated and replaced by this term, if applicable):
* ABCD 2.06 (XPATH of the equivalent term in ABCD, if applicable):
```
### Change term
Copy and paste this template into your [new issue](https://github.com/tdwg/dwc/issues/new) if you want to make a change to a term.
```
## Change term
* Term identifier (URL of the term to change):
* Justification (why is this change necessary?):
* Submitter:
I suggest the following changes (leave blank whatever would not change):
* Term name (in lowerCamelCase):
* Class (e.g. Location, Taxon):
* Definition of the term:
* Usage comments (recommendations regarding content, etc.):
* Examples:
* Refines (identifier of the broader term this term refines, if applicable):
* Replaces (identifier of the existing term that would be deprecated and replaced by this term, if applicable):
* ABCD 2.06 (XPATH of the equivalent term in ABCD, if applicable):
```
### Change documentation
Copy and paste this template into your [new issue](https://github.com/tdwg/dwc/issues/new) if you want to make a change to the documentation. Or, [fork the repository](https://github.com/tdwg/dwc/fork), make the changes yourself, and [send a pull request](https://github.com/tdwg/dwc/compare).
```
## Change documentation
* Documentation reference (URL):
* Submitter:
* Justification (why is this change necessary?):
I suggest the following changes:
```