-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
645 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Defect issue | ||
about: Use to document inconsistencies or errors | ||
title: '' | ||
labels: defect | ||
assignees: '' | ||
|
||
--- | ||
|
||
Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html | ||
|
||
Change proposals should include the following information as applicable. | ||
|
||
**Title:** Short and descriptive. | ||
**Moderator:** @user | ||
**Requirement Summary:** A few sentence functional summary | ||
**Technical Proposal Summary:** Brief proposal overview | ||
**Benefits:** Who or what will benefit from this proposal? | ||
**Status Quo:** Discussion of the current state CF and other standards. | ||
**Detailed Proposal:** Complete proposal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: Enhancement issue | ||
about: Use for issues that add new capabilities or improve existing ones | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html | ||
|
||
Change proposals should include the following information as applicable. | ||
|
||
**Title:** Short and descriptive. | ||
**Moderator:** @user | ||
**Moderator Status Review [last updated: YY/MM/DD]:** Brief comment on current status, update periodically | ||
**Requirement Summary:** A few sentence functional summary | ||
**Technical Proposal Summary:** Brief proposal overview | ||
**Benefits:** Who or what will benefit from this proposal? | ||
**Status Quo:** Discussion of the current state CF and other standards. | ||
**Detailed Proposal:** Complete proposal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Github usage issue | ||
about: Use to document an issue with how CF uses github | ||
title: '' | ||
labels: GitHubProblem | ||
assignees: '' | ||
|
||
--- | ||
|
||
Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Question Issue | ||
about: Use for questions you want help with | ||
title: '' | ||
labels: question | ||
assignees: '' | ||
|
||
--- | ||
|
||
Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Style Issue | ||
about: Use for issues concerning formatting or document syntax | ||
title: '' | ||
labels: style | ||
assignees: '' | ||
|
||
--- | ||
|
||
Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Typo Issue | ||
about: Use for small errors in spelling or grammar | ||
title: '' | ||
labels: typo | ||
assignees: '' | ||
|
||
--- | ||
|
||
Before submitting an issue be sure you have read and understand the github contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md and the rules for CF changes: http://cfconventions.org/rules.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1 @@ | ||
See http://cf-trac.llnl.gov/trac/ticket/XXX | ||
|
||
- [ ] Added link from trac ticket to this PR? | ||
|
||
> Applied via https://github.com/cf-convention/cf-conventions/pull/XXX | ||
- [ ] Updated "Revision History"? (Use the date you applied the changes.) | ||
See issue #XXX for discussion of these changes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, we pledge to respect all people who | ||
contribute through reporting issues, posting feature requests, updating | ||
documentation, submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free experience for | ||
everyone, regardless of level of experience, gender, gender identity and expression, | ||
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. | ||
|
||
Examples of unacceptable behavior by participants include the use of sexual language or | ||
imagery, derogatory comments or personal attacks, trolling, public or private harassment, | ||
insults, or other unprofessional conduct. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, | ||
commits, code, wiki edits, issues, and other contributions that are not aligned to this | ||
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed | ||
from the project team. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by | ||
opening an issue or contacting one or more of the project maintainers. | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant | ||
(http:contributor-covenant.org), version 1.0.0, available at | ||
http://contributor-covenant.org/version/1/0/0/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing to the NetCDF-CF conventions | ||
|
||
Dear CF community member, | ||
|
||
Thank you for taking the time to consider making a contribution to the [cf-conventions](http://cfconventions.org/). | ||
The NetCDF Climate and Forecasting conventions are a product by and for a broad community and your contribution is the key to their usefulness. | ||
|
||
This set of guidelines provides a brief overview of the practices and procedures that should be used in fixing, updating, or adding to the conventions. | ||
It builds on the [rules for CF Convention changes.](http://cfconventions.org/rules.html) | ||
|
||
As a prerequisite to this guide, please review the community's code of [conduct.](https://github.com/cf-convention/cf-conventions/blob/master/CODE_OF_CONDUCT.md) | ||
The CF community takes great pride in respectful and collegial discourse. Any disrespectful or otherwise derogatory communication will not be tolerated. | ||
|
||
## General Guidelines | ||
|
||
1. **A given proposal should be discussed as one issue.** It shouldn't fork or be superseded by another one, unless that reflects what has happened to the proposal. | ||
This is so it is easy to trace the discussion that led to a given agreed proposal. | ||
|
||
2. **A proposal should convey the reasoning and effect on all relevant sections of the specification.** | ||
An overview of all actual changes and the impact the changes have on the specification should be clear. | ||
Depending on the length and nature of the proposal, this may require different approaches as described below. | ||
|
||
3. **In general, issues should be used for discussion of proposed changes and pull requests should be used for review of agreed upon changes.** | ||
In other words, if the content or concept of what is being proposed needs to be vetted by the community it should be vetted in an issue. | ||
If the proposal is non-controversial (such as a typo correction) or has been agreed to in concept in an issue, then detailed review of the text may take place in a pull request. | ||
Practically all changes should be documented and discussed in an issue fixed in a related pull request. | ||
|
||
4. **Use [labels](https://github.com/cf-convention/cf-conventions/labels) on issues and pull requests.** | ||
Currently this is achieved by using an appropriate issue template when creating a [new issue](https://github.com/cf-convention/cf-conventions/issues/new/choose). | ||
|
||
## Issues and Pull Requests | ||
|
||
Issues should attempt to follow the guidelines here and in the issue template as much as possible. | ||
All new pull requests should be submitted to the master branch and will be merged or closed as soon as agreement has been reached. | ||
Use of other branches is at the discretion of the repository administrators. | ||
The following cases describe potential patterns of use for issues and pull requests. | ||
|
||
1. **Typo Fix** If the change is a non-controversial fix such as a typo, no issue is required as these changes do not appear in the convention history. | ||
A pull request with the fix can be submitted directly. | ||
Contributors not familiar with github can submit issues for typos and similar issues for others to fix. | ||
|
||
2. **Single Section Change** In the case of a change concerning one to a few paragraphs, an issue should be opened that describes the problem and proposed fix. | ||
If important to the issue, the problem text should be pasted in the body of the issue and proposed fix included. | ||
A link to the line where the problem exists could also be included. | ||
If the modification is non-controversial, a pull request could be opened simultaneously. | ||
Discussion of the proposal should take place in one issue. | ||
Final review should take place in the pull request and the issue closed when the pull request is merged. | ||
|
||
3. **Changes Spanning Multiple Sections** If reasonable, changes concerning multiple sections should follow the pattern described in Single Section Change. | ||
If explicitly listing proposed changes is not practical, general guideline 2 should be followed to document the proposal. | ||
Depending on the nature of the proposal, interested community members can decide what the most effective tool is for development and review of specification changes. | ||
Tools used for development of significant changes are up to those contributing and reviewing it. | ||
Note that there is a rendered "rich-diff" view of a pull request that can be helpful for review of large contributions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -54,5 +54,4 @@ respect to the specified dimension. | |
| `variance` | __u^2^__ | Variance | ||
|=============== | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.