Skip to content

Commit c209bf1

Browse files
authored
Change markdown templates to YAML. (#20)
Add version to init.
1 parent 3d5b606 commit c209bf1

File tree

5 files changed

+90
-41
lines changed

5 files changed

+90
-41
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 40 deletions
This file was deleted.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug report
2+
description: Create a report if you believe something is not working
3+
title: "[BUG]: "
4+
labels: ["bug"]
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: How to reproduce the bug
11+
description: Tell us how one can reproduce the bug
12+
placeholder: Run `python3 -m pytest -xvs test`
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: output
17+
attributes:
18+
label: Error output
19+
description: If you get an error message or any output, please add it here
20+
render: bash
21+
placeholder: |
22+
root@1516b1da338c:~/shared# python3 -m pytest -xvs test/
23+
============================================= test session starts ==============================================
24+
platform linux -- Python 3.10.4, pytest-7.1.3, pluggy-1.0.0 -- /usr/bin/python3
25+
cachedir: .pytest_cache
26+
rootdir: /root/shared
27+
plugins: anyio-3.6.1, cov-3.0.0
28+
collected 1 item
29+
30+
test/test_code.py::test_addition PASSED
31+
============================================== 1 passed in 0.01s ===============================================
32+
validations:
33+
required: false
34+
- type: dropdown
35+
id: version
36+
attributes:
37+
label: Version
38+
description: What version of our software are you running?
39+
options:
40+
- 0.1.0
41+
- main branch
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: output
46+
attributes:
47+
label: system
48+
description: What operating system are you using?
49+
placeholder: i.e. "I'm Ubuntu 20.04" or "Im using Windows 11"
50+
- type: textarea
51+
id: extra
52+
attributes:
53+
label: Additional information
54+
description: If you have any additional information, please add it here.
55+
placeholder: You can drag and drop files here to attach them
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature request
2+
description: Add a request for a new/missing feature
3+
title: "[Feature Request]: "
4+
labels: ["newfeature"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this feature request!
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe new/missing feature
15+
description: Tell us about what feature you are missing, and how you would like it to work.
16+
placeholder: I would like you to add a `subtraction` subroutine...
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: code-block
21+
attributes:
22+
label: Suggestion user interface
23+
description: Please create a minimal (Python) code that shows how you would like the feature to work.
24+
render: python3
25+
placeholder: No 3x``` encapsulation of code required

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,20 @@ This repository is a template for how to set up a reproducible python environmen
99
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.
1010

1111

12+
1213
## Make a repository citable
1314
The easiest way to make your repository citable is to add a `CITATION.cff` file to the repository, as it is supported by both
1415
[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.
1516

17+
## Adding an issue template
18+
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.
19+
1620
## Contributing
1721

1822
Contributions are always welcome!
1923

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

22-
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.
26+
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)
2327

2428
If you find a bug in the source code, please [open an issue](https://github.com/jorgensd/reproducibility/issues/new).

src/mypackage/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
# This file is part of my_package
55
# SPDX-License-Identifier: MIT
66

7+
import importlib.metadata
8+
79
from .functions import addition, print_add
810

11+
__version__ = importlib.metadata.version(__package__)
12+
13+
914
__all__ = ["addition", "print_add"]

0 commit comments

Comments
 (0)