Skip to content

Commit

Permalink
[Fixes #33] Update .github templates for PRs and Issues
Browse files Browse the repository at this point in the history
  • Loading branch information
mwallschlaeger committed Mar 14, 2024
1 parent 45b27bf commit 0e2d0fb
Show file tree
Hide file tree
Showing 7 changed files with 80 additions and 135 deletions.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: bug
about: Create an issue of a bug
title: 'Bug: ???'
labels: 'bug'
---

## Bug Description

A clear and concise description of the bug.

## Reproduction Steps

best to provide your values.yaml, a brief description of your cluster and version of geonode-k8s here.

## Behavior

A description of what you expected to happen and what actually happened.

## Additional Information

Any additional information or context that may be helpful in resolving the bug.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: new feature
about: Create an issue of a feature request.
title: 'Feature: ???'
labels: 'feature'
---

## Feature Description

A clear and concise description of the feature.

## Proposed Solution

A description of how you propose implementing the feature.

## Additional Information

Any additional information or context that may be helpful in implementing the feature.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

70 changes: 0 additions & 70 deletions .github/ISSUE_TEMPLATE/gnip.md

This file was deleted.

28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/report_issue.md

This file was deleted.

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/task_docs_others.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: new task/todo
about: Create an issue of a task or todo, e.g. missing docs
title: 'Task: ???'
labels: 'task'
---

## Task Description

A clear and concise description of the task.

## Additional Information

Any additional information or context that may be helpful in completing the task.
43 changes: 26 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,33 @@
<Include a few sentences describing the overall goals for this Pull Request>
## Description

A brief description of the feature or bug that this pull request addresses.

## Type of Change

Please select the relevant option:

- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Refactoring
- [ ] Other (please describe)

## Related Issue

If there is an existing issue related to this pull request, please reference it here.

closes #

## Checklist

> Reviewing is a process done by project maintainers, mostly on a volunteer basis. We try to keep the overhead as small as possible and appreciate if you help us to do so by completing the following items. Feel free to ask in a comment if you have troubles with any of them.
Please ensure that your pull request meets the following requirements:

For all pull requests:
- The pull request is limited to one type (docs, feature, bug fix, etc.)
- The pull request is as small as possible. Consider opening multiple pull requests instead of one large one.
- The feature or bug fix has been discussed and documented in an issue beforehand.

- [ ] Confirm you have read the [contribution guidelines](https://github.com/GeoNode/geonode/blob/master/CONTRIBUTING.md)
- [ ] You have sent a Contribution Licence Agreement (CLA) as necessary (not required for small changes, e.g., fixing typos in the documentation)
- [ ] Make sure the first PR targets the master branch, eventual backports will be managed later. This can be ignored if the PR is fixing an issue that only happens in a specific branch, but not in newer ones.
## Additional Notes

The following are required only for core and extension modules (they are welcomed, but not required, for contrib modules):
- [ ] There is a ticket in https://github.com/GeoNode/geonode/issues describing the issue/improvement/feature (a notable exemption is, changes not visible to end-users)
- [ ] The issue connected to the PR must have Labels and Milestone assigned
- [ ] PR for bug fixes and small new features are presented as a single commit
- [ ] Commit message must be in the form "[Fixes #<issue_number>] Title of the Issue"
- [ ] New unit tests have been added covering the changes, unless there is an explanation on why the tests are not necessary/implemented
- [ ] This PR passes all existing unit tests (test results will be reported by travis-ci after opening this PR)
- [ ] This PR passes the QA checks: black geonode && flake8 geonode
- [ ] Commits changing the **settings**, **UI**, **existing user workflows**, or adding **new functionality**, need to include documentation updates
- [ ] Commits adding **new texts** do use gettext and have updated .po / .mo files (without location infos)
Any additional information or context regarding the pull request can be provided here.

**Submitting the PR does not require you to check all items, but by the time it gets merged, they should be either satisfied or inapplicable.**
Thank you for creating this pull request

0 comments on commit 0e2d0fb

Please sign in to comment.