mirror of https://github.com/tdwg/dwc.git
50 lines
3.4 KiB
Markdown
50 lines
3.4 KiB
Markdown
Issues guidelines should go here.
|
|
|
|
From https://help.github.com/articles/setting-guidelines-for-repository-contributors/, the file could include:
|
|
|
|
* Steps for creating good issues or pull requests.
|
|
* Links to external documentation, mailing lists, or a code of conduct.
|
|
* Community and behavioral expectations.
|
|
|
|
Dump from wiki:
|
|
|
|
## Submitting issues
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
### Term definition recommendation
|
|
|
|
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.
|
|
|
|
The information requested in this type of issue includes:
|
|
|
|
Submitter, Term Name, Recommendation.
|
|
|
|
### New term request
|
|
|
|
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.
|
|
|
|
The information requested in this type of issue includes:
|
|
|
|
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.
|