Skip to content

Commit

Permalink
Create CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
MathewBiddle authored Jul 11, 2024
1 parent 3efc5f0 commit 2cb6fe8
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions CONTRIBUTING
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing

## How this branch of the repo is organized
* **crosswalk/** - contains spreadsheet crosswalking CF/ACDD to DarwinCore.
* **data/** - contains example data files.
* **notebooks/** - contains example Python notebooks for reading data files.
* **templates/** - contains [common data language (cdl)](https://www.unidata.ucar.edu/software/netcdf/workshops/most-recent/nc3model/Cdl.html#:~:text=CDL%20(Common%20Data%20Language)%20is,for%20netCDF%20objects%20and%20data.&text=This%20example%20specifies%20a%20netCDF,data%20values%20for%20the%20variable.) netCDF templates.
* README-ArchiveSOP.md - Documentation about the procedure for archiving at NCEI.
* README-ATN2DWC.md - Documentation about the mapping from ATN netCDF to DwC.

## How to Contribute
The easiest way to get started is to file an issue to tell us about a spelling mistake, some awkward wording,
or a factual error. This is a good way to introduce yourself and to meet some of our community members.

1. If you have a [GitHub][github] account, or are willing to [create one][github-join], but do not know how to use Git,
you can report problems or suggest improvements by [creating an issue][issues]. This allows us to assign the item
to someone and to respond to it in a threaded discussion.

2. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR).
Instructions for doing this are [included below](#using-github).

## Where to Contribute
Contribute your updates to the appropriate files using [markdown syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). You can:

1. Update an existing page.
2. Create a new page.

## Using GitHub

If you choose to contribute via GitHub, you may want to look at [How to Contribute to an Open Source Project on
GitHub][how-contribute]. To manage changes, we follow [GitHub flow][github-flow]. To use the web interface for
contributing to a file:

1. Fork the originating repository to your GitHub profile.
2. Within your version of the forked repository, move to the `gh-pages` branch.
3. Navigate to the file(s) you wish to change within the branch and make revisions as required.
4. Commit all changed files within the appropriate branch.
5. Create pull requests from your changed branch to the `gh-pages` branch within the originating
repository.
6. If you receive feedback, make changes using your issue-specific branches of the forked repository and the pull
requests will update automatically.
7. Repeat as needed until all feedback has been addressed.

When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date before creating your own
revision-specific branch(es) from there.

[github]: https://github.com
[github-flow]: https://guides.github.com/introduction/flow/
[github-join]: https://github.com/join
[how-contribute]: https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github
[issues]: https://guides.github.com/features/issues/

0 comments on commit 2cb6fe8

Please sign in to comment.