Skip to content

Commit

Permalink
additional formatting and phrasing updates to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kafitzgerald authored Dec 8, 2023
1 parent 614f7a4 commit bbcc1fa
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,32 @@ Below are guidelines for adding new files to geocat-datafiles:

# Policies for adding new files

1. Knowing that Github allows a maximum size of 100 MB for a single file upload, small(ish) example
data sets - on the order of a few MBs - should be chosen for testing or examples.
1. Knowing that Github allows a maximum size of 100 MB for a single file upload, small(ish) example
data sets - on the order of a few MBs - should be chosen for testing or examples.

- Contributors should endeavor to use existing data sets before considering contributing new ones.
- However, if an existing data set simply won’t do the job, new ones may certainly be added.
- Contributors should ensure that contributed files are stripped of irrelevant variables that unnecessarily
take up space.
- Contributors should endeavor to use existing data sets before considering contributing new ones. However,
if an existing data set simply won’t do the job, new ones may be added.
- Contributors should ensure that contributed files are stripped of irrelevant variables that unnecessarily
take up space.

2. Contributors of data sets are responsible for ensuring that they have appropriate permissions for
redistribution of any contributed data sets.
3. Contributors of data sets are responsible for ensuring that they have appropriate permissions for
redistribution of any contributed data sets.


# Adding new data files to the ``geocat-datafiles`` repo
# Adding new data files to the GeoCAT-datafiles repository

1. Add files to appropriate subdirectory based on file format, e.g. “`netcdf_files`”, etc
1. Add files to appropriate subdirectory based on file format, e.g. “`netcdf_files`”, etc.

2. Generate new “registry.txt” by running the command:
2. Generate a new “registry.txt” by running the command:

`python create_registry.py`

- This command requires [PyPi's Pooch framework](https://pypi.org/project/pooch/) to be installed.

- Please follow the [installation instructions](https://github.com/NCAR/geocat-datafiles/INSTALLATION.md)
to ensure an accurate conda environment is installed and activated for GeoCAT-datafiles, including
[PyPi's Pooch framework](https://pypi.org/project/pooch/).
- This command requires [Pooch](https://pypi.org/project/pooch/) to be installed. Please follow the
[installation instructions](https://github.com/NCAR/geocat-datafiles/INSTALLATION.md) to ensure your active
conda environment includes the required packages.

3. Open a pull request with these changes on [NCAR/geocat-datafiles](https://github.com/NCAR/geocat-datafiles). Once
the pull request is merged, the files should be available. No package release is required.

**Note**: Python package in `$GEOCATDATAFILES/src` directory, very minimal maintenance required, does not need to be
updated when a new file is added.
Expand Down

0 comments on commit bbcc1fa

Please sign in to comment.