From acc10884abac6b089942bd0b494cce1b18823bb5 Mon Sep 17 00:00:00 2001 From: Mark Piper Date: Fri, 22 Mar 2024 10:32:24 -0600 Subject: [PATCH 1/3] Link to project contributing and code of conduct docs --- CODE-OF-CONDUCT.md | 4 ++ CONTRIBUTING.md | 134 +-------------------------------------------- 2 files changed, 7 insertions(+), 131 deletions(-) create mode 100644 CODE-OF-CONDUCT.md diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md new file mode 100644 index 0000000..6eec358 --- /dev/null +++ b/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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4223fbc..dc4e699 100644 --- a/CONTRIBUTING.md +++ b/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 . - -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 -. - -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 git@github.com: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. From bdf6c3f15b9026da68d18ce2c33bf5e7d3452386 Mon Sep 17 00:00:00 2001 From: Mark Piper Date: Fri, 22 Mar 2024 11:34:35 -0600 Subject: [PATCH 2/3] Make pretty --- bmi_geotiff/bmi.py | 1 - bmi_geotiff/io.py | 2 +- examples/example-pan.py | 1 + examples/example-rgb.py | 1 + tests/test_io.py | 1 + 5 files changed, 4 insertions(+), 2 deletions(-) diff --git a/bmi_geotiff/bmi.py b/bmi_geotiff/bmi.py index 30ad573..245fcba 100644 --- a/bmi_geotiff/bmi.py +++ b/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" diff --git a/bmi_geotiff/io.py b/bmi_geotiff/io.py index a643342..8c030c8 100644 --- a/bmi_geotiff/io.py +++ b/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): diff --git a/examples/example-pan.py b/examples/example-pan.py index 81ced7e..6537668 100644 --- a/examples/example-pan.py +++ b/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 diff --git a/examples/example-rgb.py b/examples/example-rgb.py index 8638ca6..8637be0 100644 --- a/examples/example-rgb.py +++ b/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 diff --git a/tests/test_io.py b/tests/test_io.py index 5f27b03..8bd81c1 100644 --- a/tests/test_io.py +++ b/tests/test_io.py @@ -1,4 +1,5 @@ """Test the bmi_geotiff.io module""" + from pathlib import Path import pytest From a2906491e490f95676db98da8167bebbb76e25c8 Mon Sep 17 00:00:00 2001 From: Mark Piper Date: Fri, 22 Mar 2024 11:36:49 -0600 Subject: [PATCH 3/3] Update changelog --- CHANGES.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES.md b/CHANGES.md index 6aeb9be..ab67309 100644 --- a/CHANGES.md +++ b/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)