Skip to content
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
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Bug report
description: Create a report if you believe something is not working
title: "[BUG]: "
labels: ["bug"]

body:
- type: textarea
id: description
attributes:
label: How to reproduce the bug
description: Tell us how one can reproduce the bug
placeholder: Run `python3 -m pytest -xvs test`
validations:
required: true
- type: textarea
id: output
attributes:
label: Error output
description: If you get an error message or any output, please add it here
render: bash
placeholder: |
root@1516b1da338c:~/shared# python3 -m pytest -xvs test/
============================================= test session starts ==============================================
platform linux -- Python 3.10.4, pytest-7.1.3, pluggy-1.0.0 -- /usr/bin/python3
cachedir: .pytest_cache
rootdir: /root/shared
plugins: anyio-3.6.1, cov-3.0.0
collected 1 item

test/test_code.py::test_addition PASSED
============================================== 1 passed in 0.01s ===============================================
validations:
required: false
- type: dropdown
id: version
attributes:
label: Version
description: What version of our software are you running?
options:
- 0.1.0
- main branch
validations:
required: true
- type: textarea
id: output
attributes:
label: system
description: What operating system are you using?
placeholder: i.e. "I'm Ubuntu 20.04" or "Im using Windows 11"
- type: textarea
id: extra
attributes:
label: Additional information
description: If you have any additional information, please add it here.
placeholder: You can drag and drop files here to attach them
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature request
description: Add a request for a new/missing feature
title: "[Feature Request]: "
labels: ["newfeature"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: textarea
id: description
attributes:
label: Describe new/missing feature
description: Tell us about what feature you are missing, and how you would like it to work.
placeholder: I would like you to add a `subtraction` subroutine...
validations:
required: true
- type: textarea
id: code-block
attributes:
label: Suggestion user interface
description: Please create a minimal (Python) code that shows how you would like the feature to work.
render: python3
placeholder: No 3x``` encapsulation of code required
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,20 @@ This repository is a template for how to set up a reproducible python environmen
To be able to create a python package, we need a folder with the name of the package (in this repository `mypackage`), and a `pyproject.toml` file.



## Make a repository citable
The easiest way to make your repository citable is to add a `CITATION.cff` file to the repository, as it is supported by both
[Zenodo's](https://zenodo.org/) and it's [Github integration](https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content) and [Github](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) itself.

## Adding an issue template
See [Adding an issue template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository) for more information.

## Contributing

Contributions are always welcome!

See [CONTRIBUTING.md](CONTRIBUTING.md) for ways to get started.

A good idea is to look at the [issue tracker](https://github.com/jorgensd/reproducibility/issues) and see if you can resolve any open issues.
A good idea is to look at the [issue tracker](https://github.com/jorgensd/reproducibility/issues) and see if you can resolve any open issues. A list of good first issues can be found [here](https://github.com/jorgensd/reproducibility/contribute)

If you find a bug in the source code, please [open an issue](https://github.com/jorgensd/reproducibility/issues/new).
5 changes: 5 additions & 0 deletions src/mypackage/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
# This file is part of my_package
# SPDX-License-Identifier: MIT

import importlib.metadata

from .functions import addition, print_add

__version__ = importlib.metadata.version(__package__)


__all__ = ["addition", "print_add"]