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.

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

Addition of PR templates #8

Merged
merged 2 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Bug Fix

- Please insert link to github issue here:

## What is the bug?

If possible please include a summary and reproducible use-case below:

```python
>>> (insert example here)
```

## How does the change fix it?

Include a short description outlining how your change fixes current behaviour

## Code

- [ ] Is code production ready (no stub/test functions, hardcoded IP/ tables/ hostnames, etc.)?

## Testing

- [ ] Have unit tests been created or existing ones updated to catch this bug in the future?
- [ ] Has test coverage remained the same or improved?
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Documentation template

## What does this change introduce?

## Checklist

- [ ] Have you ensured that any changes to the documentation are correctly formatted, in particular are code snippets being correctly displayed?
- [ ] If a new class has been added has a documentation stub `.md` file associated with it been created?
- [ ] Have you ensured that any included hyperlinks are operating correctly?
- [ ] If any documentation page has been created has it been added to `mkdocs.yml`
- [ ] Have you checked your changes with a spell checker? (US English)
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Feature

- Please insert link to associated issue here:

## What does this change introduce?

## General

- [ ] Has an example been added to demo the new feature?
- [ ] Have existing examples been updated or tested?
- [ ] Have you added any new Environment Variables/Configuration Options? If yes please tick the boxes below as applicable
- [ ] Addition to reimporter logic within `src/pykx/pykx.q` and `src/pykx/reimporter.py`
- [ ] Have updated the `src/pykx/util.py` logic which is used for environment variable
- [ ] If there have been any dependency updates have they been reflected in all files?
- [ ] pyproject.toml
- [ ] docs/getting-started/installing.md
- [ ] conda-recipe/meta.yaml
- [ ] README.md
- [ ] If any examples have been updated has it's associated `.zip` been updated

## Code

- [ ] Has all temporary code used during development been removed?
- [ ] Has all commented out (unused) code been removed?
- [ ] Where reasonable have you ensured there is no duplication of existing code?
- [ ] If applicable for your use-case have you ensured that the code is performant?

## Testing

- [ ] Have unit tests been created or existing ones updated to test this new functionality?

## Documentation

- [ ] Has documentation been added for all public code?
- [ ] Has a release note been included for the new feature?
- [ ] Has any documentation which would benefit from this feature been updated to use the most up to date functionality?
- [ ] If a new class has been added has a documentation stub `.md` file associated with it been created?
- [ ] If any documentation page has been created has it been added to `mkdocs.yml`
- [ ] Have you checked your changes with a spell checker? (US English)