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

Update contributing file 

Closes #50
This commit is contained in:
Peter Desmet 2015-01-12 13:21:36 +01:00
parent b26fde989a
commit 3f7a4cbf53
1 changed files with 44 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

136
CONTRIBUTING.md
View File

@ -1,116 +1,68 @@
Issues guidelines should go here.
# Guidelines for contributing
From https://help.github.com/articles/setting-guidelines-for-repository-contributors/, the file could include:
Changes to the standard are subject to the [change policy](changepolicy.html). Here's how you can contribute:
* Steps for creating good issues or pull requests.
* Links to external documentation, mailing lists, or a code of conduct.
* Community and behavioral expectations.
* 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.
Dump from wiki:
## Issue templates
## Submitting issues
### New term
If you wish to submit concrete recommendations for the Darwin Core Standard that can be assessed, assigned, tracked, and archived, the Issue Tracking System on this site is the mechanism for managing these recommendations.
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 of such an issue)[]).
For any new issue, open the [Issues](http://code.google.com/p/darwincore/issues/list) page (accessible from this page by clicking on the `Issues` tab above. It may be a good idea to review the list of issues to see if the issue you want to report has already been reported. If it has, you may want to add comments to that existing issue. To do so, click on the row containing the issue to open it's detailed view, then click in the `Add a comment and make changes` text box and enter your comments. When you are finished, click on the `Save changes` button on the bottom of the page.
If you do not find an existing issue for what you want to report, click in the [New Issue](http://code.google.com/p/darwincore/issues/entry) link on the first row of controls on the [Issues](http://code.google.com/p/darwincore/issues/list) page. Decide which of the basic types of issues (see the list and specific instructions for these below) best matches the one you want to report and select the appropriate template in the `Template` selection box. A form appropriate to your choice will appear. Fill in the form as completely and clearly as possible following the guidelines given within the template itself. When you have finished filling in the form, click on the `Submit issue` button at the bottom of the page.
There are four types of issues that should be reported using this system. Descriptions of these categories of issues are given below and are directly accessible from the following links:
### Documentation error report
This type of issue is to report an error in the documentation (web pages) for the Darwin Core Standard. Select the `Documentation Error` template and follow the guidelines provided in the `Description` text box in the Issue Report Form.
The information requested in this type of issue includes:
Submitter, URL, Error description, Recommended remedy.
Template
```
This type of issue is to report an error in the Darwin Core Standard
documentation. Add a label for the document on which the error occurs.
These can be selected in the Labels section of the issue tracker. In
addition, please include the URL to the document in your comment if
applicable. Describe the error and its remedy as clearly as possible, and
please identify yourself as the submitter if you want attribution for the
error report.
## New term
Please do not contribute more than one error report per issue. It will help
us to manage and track changes if distinct problems are identified in their
own issues.
* Submitter:
* Proponents (at least two independent parties who need this term):
* Justification (why is this term necessary?):
==Documentation Error Report==
URL:
Error description:
Recommended remedy:
Submitter:
Proposed definition of the new term:
* Term name (in lowerCamelCase):
* Class (e.g. Location, Taxon):
* Definition of the term:
* Comment (examples, recommendations regarding content, etc.):
* 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):
```
### Term change recommendation
### Change term
This type of issue is to make a recommendation for a change to a Darwin
Core term definition. Select the `Term Definition` template and follow the guidelines provided in the `Description` text box in the Issue Report Form.
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 ((example of such an issue)[]).
The information requested in this type of issue includes:
Submitter, Term Name, Recommendation.
Template
```
This type of issue is to make a recommendation for a change to an existing
Darwin Core term. Provide the Term Name (e.g., institutionCode) in the
Summary (above), describe the recommendation as clearly as possible, and
please identify yourself as the submitter if you want attribution for the
change recommendation.
## Change term
Please do not contribute recommendations for more than one term in a single
issue. It will help us to manage and track changes if recommendations for
distinct terms are identified in their own issues. Any number of
recommendations for a single term may be made in the same issue.
* Term identifier (URL of the term to change):
* Submitter:
* Justification (why is this change necessary?):
==Term Definition Recommendation==
Term Name:
Recommendation:
Submitter:
I suggest the following changes (leave blank whatever would not change):
* Term name (in lowerCamelCase):
* Definition of the term:
* Comment (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):
```
### New term request
### Change documentation
This type of issue is to make a recommendation for a new Darwin
Core term. Select the `New Term` template and follow the guidelines provided in the `Description` text box in the Issue Report Form.
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 ((example of such an issue)[]). 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).
The information requested in this type of issue includes:
Submitter, Justification, Definition, Comment, Refines, Has Domain, Has Range, Replaces, ABCD 2.06:
Template
```
This type of issue is to make a recommendation for a new Darwin
Core term. Provide a justification for the new term as well as all of the
attributes of the new term in the template below. For definitions of the
term attributes, see the The Terms: Definitions section of the Complete
History page (http://rs.tdwg.org/dwc/terms/history/index.htm#theterms).
Please identify yourself as the submitter if you want attribution for the
change recommendation.
## Change documentation
* Documentation reference (URL):
* Submitter:
* Justification (why is this change necessary?):
I suggest the following changes:
Please do not contribute recommendations for more than one term issue. It
will help us to manage and track changes if recommendations for distinct
terms are identified in their own issues. Any number of recommendations for
a single term may be made in the same issue.
==New Term Recommendation==
Submitter:
Justification:
Definition:
Comment:
Refines:
Has Domain:
Has Range:
Replaces:
ABCD 2.06:
```
### Question
This type of issue is to ask for a clarification about something without being able to pose a solution to it yourself. If the topic is broad and requires discussion, post it instead to the discussion forum at tdwg-content@lists.tdwg.org.