Skip to content

Commit

Permalink
DAS-1385 - Add Pull Request template to repository.
Browse files Browse the repository at this point in the history
  • Loading branch information
owenlittlejohns committed May 23, 2022
1 parent e161695 commit 1f48213
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Description

A short description of the changes in this PR.

## Jira Issue ID


## Local Test Steps


## PR Acceptance Checklist
* [ ] Jira ticket acceptance criteria met.
* [ ] `version.txt` and `CHANGE.md` updated if any service code is changed.
* [ ] Tests added/updated and passing.
* [ ] Documentation updated (if needed).
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# harmony-gdal-adapter
# harmony-gdal-adapter (HGA)

![](https://data-services-github-badges.s3.amazonaws.com/cov.svg?dummy=true)

Expand Down Expand Up @@ -52,3 +52,15 @@ pip install -r requirements.txt -r requirements_dev.txt
./tests/run_tests.sh
```
This script runs pytest on the `./tests` directory.

## Contributions:

Contributions to HGA can be made via submitting a pull request to this
repository. When doing so, it is important to make updates to `version.txt`
and `CHANGE.md`. Every time code is merged to the `main` branch, a Docker image
is published to [ghcr.io](https://github.com/nasa/harmony-gdal-adapter/pkgs/container/harmony-gdal-adapter). The semantic version number listed in `version.txt` must be iterated to
avoid overwriting an existing Docker image.

When writing or updating service code, please also update the existing test
suite with unit tests to ensure the new functionality performs as expected, and
continues to do so following subsequent development.

0 comments on commit 1f48213

Please sign in to comment.