Merge pull request #23 from csdms/mdpiper/link-to-project-docs

Link to project contributing and code of conduct docs

CHANGES.md

@@ -4,13 +4,14 @@ Changes for bmi-geotiff
 0.3.2 (unreleased)
 ------------------
 
+- Link to project contributing and code of conduct docs (#23)
 - Update citation file to cff 1.2.0
 
 
 0.3.1 (2023-08-28)
 ------------------
 
-- Update build and test process #19
+- Update build and test process (#19)
 
 
 0.3 (2022-08-04)

CODE-OF-CONDUCT.md

@@ -0,0 +1,4 @@
+# Code of Conduct
+
+Everyone participating in this project is governed by the CSDMS [Code of Conduct](https://github.com/csdms/project/blob/main/CODE-OF-CONDUCT.md).
+By participating, you are expected to uphold this code.

CONTRIBUTING.md

@@ -1,133 +1,5 @@
 # Contributing
 
-Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given.
-
-You can contribute in many ways:
-
-## Types of Contributions
-
-### Report Bugs
-
-Report bugs at <https://github.com/csdms/bmi-geotiff/issues>.
-
-If you are reporting a bug, please include:
-
--   Your operating system name and version.
--   Any details about your local setup that might be helpful in
-    troubleshooting.
--   Detailed steps to reproduce the bug.
-
-### Fix Bugs
-
-Look through the GitHub issues for bugs. Anything tagged with "bug"
-and "help wanted" is open to whoever wants to implement it.
-
-### Implement Features
-
-Look through the GitHub issues for features. Anything tagged with
-"enhancement" and "help wanted" is open to whoever wants to
-implement it.
-
-### Write Documentation
-
-*bmi-geotiff* could always use more documentation, whether as part of the
-official docs, in docstrings, or even on the web in blog
-posts, articles, and such.
-
-### Submit Feedback
-
-The best way to send feedback is to file an issue at
-<https://github.com/csdms/bmi-geotiff/issues>.
-
-If you are proposing a feature:
-
--   Explain in detail how it would work.
--   Keep the scope as narrow as possible, to make it easier to
-    implement.
--   Remember that this is a volunteer-driven project, and that
-    contributions are welcome :)
-
-## Get Started!
-
-Ready to contribute? Here\'s how to set up *bmi-geotiff* for local
-development.
-
-1.  Fork the *bmi-geotiff* repo on GitHub.
-
-2.  Clone your fork locally:
-
-    ``` {.shell}
-    $ git clone [email protected]:your_name_here/bmi-geotiff.git
-    ```
-
-3.  Install your local copy into a conda environment. A conda enviroment file is
-    supplied at the root of the repository. Assuming you have conda installed,
-    this is how you set up your fork for local development:
-
-    ``` {.shell}
-    $ cd bmi-geotiff
-    $ conda env create --file=environment.yml
-    $ conda activate geotiff
-    $ make install
-    ```
-
-4.  Create a branch for local development:
-
-    ``` {.shell}
-    $ git checkout -b name-of-your-bugfix-or-feature
-    ```
-
-    Now you can make your changes locally.
-
-5.  When you're done making changes, check that your changes pass
-    flake8 and the tests:
-
-    ``` {.shell}
-    $ make lint
-    $ make test
-    ```
-
-    Both flake8 and pytest are included in the environment.
-
-6.  Commit your changes and push your branch to GitHub:
-
-    ``` {.shell}
-    $ git add .
-    $ git commit -m "Your detailed description of your changes."
-    $ git push origin name-of-your-bugfix-or-feature
-    ```
-
-7.  Submit a pull request through the GitHub website.
-
-## Pull Request Guidelines
-
-Before you submit a pull request, check that it meets these guidelines:
-
-1.  The pull request should include tests.
-2.  If the pull request adds functionality, the docs should be updated.
-    Put your new functionality into a function with a docstring, and add
-    the feature to the list in README.rst.
-3.  The pull request need only work with Python >= 3.8.
-
-
-## Deploying
-
-A reminder for the maintainers on how to deploy. To make a new release,
-you will need to have
-[zest.releaser](https://zestreleaser.readthedocs.io/en/latest/)
-installed, which can be installed with *pip*,
-
-``` {.bash}
-$ pip install zest.releaser[recommended]
-```
-
-Make sure all your changes are committed (including an entry in
-CHANGES.md). Then run,
-
-``` {.bash}
-$ fullrelease
-```
-
-This will create a new tag and alert the *bmi-geotiff* feedstock on
-*conda-forge* that there is a new release.
+We welcome, and greatly appreciate, contributions to [CSDMS Workbench](https://csdms.colorado.edu/wiki/Workbench) tools.
+For recommendations on how you can contribute,
+please see the CSDMS project [CONTRIBUTING](https://github.com/csdms/project/blob/main/CONTRIBUTING.md) document.

bmi_geotiff/bmi.py

@@ -18,7 +18,6 @@
 
 
 class BmiGeoTiff(Bmi):
-
     """BMI-mediated access to data and metadata in a GeoTIFF file."""
 
     _name = "bmi-geotiff"

bmi_geotiff/io.py

@@ -1,10 +1,10 @@
 """Access GeoTIFF files."""
+
 import rioxarray
 from rasterio.crs import CRS
 
 
 class GeoTiff:
-
     """Access data and metadata in a GeoTIFF file."""
 
     def __init__(self, filename=None):

examples/example-pan.py

@@ -2,6 +2,7 @@
 
 The data used are band 1 of Landsat 7 ETM scene LE71030642021102ASA00.
 """
+
 import matplotlib.pyplot as plt
 
 from bmi_geotiff import GeoTiff

examples/example-rgb.py

@@ -3,6 +3,7 @@
 The example is adapted from http://xarray.pydata.org/en/stable/examples/visualization_gallery.html#imshow()-and-rasterio-map-projections,
 and it uses the sample GeoTIFF image "RGB.byte.tif" from the rasterio project.
 """
+
 import cartopy.crs as ccrs
 import matplotlib.pyplot as plt
 

tests/test_io.py

@@ -1,4 +1,5 @@
 """Test the bmi_geotiff.io module"""
+
 from pathlib import Path
 
 import pytest