Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributor's guide #166

Merged
merged 6 commits into from
Oct 3, 2023
Merged

Contributor's guide #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2da3edc
add contrib.rst to docs
kafitzgerald Sep 30, 2023
c6df6ca
Fix contributor's guide links
kafitzgerald Oct 2, 2023
d083663
fix a few more links in README
kafitzgerald Oct 3, 2023
c25ace9
a few more edits to contrib.rst
kafitzgerald Oct 3, 2023
521008f
edits to release notes
kafitzgerald Oct 3, 2023
b3ed5a0
fix whitespace
kafitzgerald Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ apply to this PR, comment it out or delete it. -->
Thank you so much for your PR! To help us review your contribution, please
consider the following points:

- A contributor's guide is available at https://geocat-viz.readthedocs.io/en/latest/contrib.html

- Fork this repository and open the PR from your fork. Do not directly work on
the NCAR/geocat-viz repository.

Expand Down
57 changes: 1 addition & 56 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1 @@
Please first refer to [GeoCAT Contributor's Guide](https://geocat.ucar.edu/pages/contributing.html) for overall
contribution guidelines (such as detailed description of GeoCAT structure, forking, repository cloning,
branching, etc.). Once you determine that a function should be contributed under this repo, please refer to the
following contribution guidelines:


# Adding new utility functions to the Geocat-viz repo

1. Please check the followings to ensure that the functionality you are about to work on has not been ported yet:

- Functions implemented in `$GEOCAT_VIZ/src/geocat/viz/util/util.py`,

- The list of [GeoCAT-viz Issues](https://github.com/NCAR/GeoCAT-viz/issues) and
[GeoCAT-examples Issues](https://github.com/NCAR/GeoCAT-examples/issues) to see if any of
the existing to-do items are something you might be interested in working on,

- If so, please comment (or self-assign the issue if you have permissions to do so) indicating that
you intend to work on it.

- Otherwise, you may create and self-assign an issue under
[GeoCAT-viz Issues](https://github.com/NCAR/GeoCAT-viz/issues)
that describes need for the functionality you are planning to contribute.

2. Define a new function and implement it under the `$GEOCAT_VIZ/src/geocat/viz/util/util.py`.

# Adding new plotting utility functionality to the Geocat-viz repo

1. Please check the followings to ensure that the functionality you are about to work on has not been ported yet:

- Functions implemented in `$GEOCAT_VIZ/src/geocat/viz/`

- The list of [GeoCAT-viz Issues](https://github.com/NCAR/GeoCAT-viz/issues) and
[GeoCAT-examples Issues](https://github.com/NCAR/GeoCAT-examples/issues) to see if any of
the existing to-do items are something you might be interested in working on,

- If so, please comment (or self-assign the issue if you have permissions to do so) indicating that
you intend to work on it.

- Otherwise, you may create and self-assign an issue under
[GeoCAT-viz Issues](https://github.com/NCAR/GeoCAT-viz/issues)
that describes need for the functionality you are planning to contribute.

2. Determine which module is the best home for your new function.

- If necessary, create a new `.py` module under `$GEOCAT_VIZ/src/geocat/viz/`.

- Implement your plotting function inside the chosen module, making
use of the pre-defined parent classes if appropriate

3. Add new modules to the namespace by adding it to `$GEOCAT_VIZ/src/geocat/viz/__init__.py`

# Adding functionality to the User API Documentation

1. Add your new function to `GEOCAT_VIZ/docs/user_api/index.rst`.

2. Ensure that the function docstring has examples linking to relevant GeoCAT-Examples scripts.
The contributor's guide for GeoCAT-viz can be found in our [online documentation](https://geocat-viz.readthedocs.io/en/latest/contrib.html).
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ plotting packages. GeoCAT-viz functionality is used by

[GeoCAT Homepage](https://geocat.ucar.edu/)

[GeoCAT-viz Contributor's Guide](https://github.com/NCAR/geocat-viz/blob/main/CONTRIBUTING.md)
[GeoCAT-viz Contributor's Guide](https://geocat-viz.readthedocs.io/en/latest/contrib.html)

[GeoCAT-viz documentation on Read the Docs](https://geocat-viz.readthedocs.io)
[GeoCAT-viz Documentation on Read the Docs](https://geocat-viz.readthedocs.io)

# Installation instructions

Please see our documentation for [installation instructions](https://github.com/NCAR/geocat-viz/blob/main/INSTALLATION.md).
Please see our documentation for [installation instructions](https://geocat-viz.readthedocs.io/en/latest/installation.html).

# Citing GeoCAT-viz

Expand Down
Loading