Skip to content

Commit dafc41c

Browse files
authored
improve templates (#189)
* improve templates * fix filenames and extend contributing
1 parent 2a524b9 commit dafc41c

File tree

5 files changed

+50
-3
lines changed

5 files changed

+50
-3
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
---
2-
name: 'Bug Report'
3-
about: Inform about errors and mistakes in the notebooks
2+
name: 'Notebook Error Report'
3+
about: Inform about errors and mistakes in the example notebooks
44

55
---
6+
7+
**Notebook title**:
8+
**Notebook url**:
9+
10+
## Issue description
11+
Explain the bug, error or mistake, where it is in the notebook, if it happens
12+
only once or multiple times...
13+
14+
*Note that this issue tracker is about the contents in the notebooks, if
15+
the notebook is instead triggering a bug or error in pymc3, please
16+
report to https://github.com/pymc-devs/pymc3/issues instead*
17+
18+
## Expected output
19+
If applicable, describe what should happen instead.
20+
21+
## Proposed solution
22+
If applicable, explain possible solutions and workarounds.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: PyMC Discourse
4+
url: https://discourse.pymc.io/
5+
about: Ask usage questions about PyMC3 or doubts about the examples here
6+
- name: PyMC3 bug report
7+
url: https://github.com/pymc-devs/pymc3/issues
8+
about: Please report bugs or propose enhancements of the PyMC3 library here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: 'Propose a new example notebook'
3+
about: Propose new content based on gaps in the current collection
4+
labels: proposal
5+
6+
---
7+
8+
# Notebook proposal
9+
**Title**: Use this also as issue title
10+
11+
## Why should this notebook be added to pymc-examples?
12+
Explain why this topic is interesting and useful to PyMC3 users.
13+
14+
## Related notebooks
15+
Cover related notebooks on which this notebook will build,
16+
make sure that the notebook is not duplicated and
17+
explain whether it should be a new notebook or extend an existing one.
18+
19+
# References
20+
If applicable, references and material that could help in writing the notebook.

.github/ISSUE_TEMPLATE/tracker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: 'Tracker issue'
3-
about: Create a tracker issue for the GitHub project
3+
about: *Internal template for PyMC documentation team only*
44
labels: tracker id
55

66
---

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ We recommended that your contribution complies with the following guidelines bef
9595

9696
* Use the pull request title to describe the issue and mention the issue number in the pull request description. This will make sure a link back to the original issue is created. For example, use `Use ArviZ in sampler stats notebook` as a title and link to [#46](https://github.com/pymc-devs/pymc-examples/issues/46) in the description.
9797
* Please do not submit PRs that are not addressing an issue already present in the issue tracker.
98+
* If you want to add a new notebook and no issue related to it is present yet, open one so we can
99+
discuss the best way to add the content to the repo. We have an issue template for that.
98100

99101
* Prefix the title of incomplete contributions with `[WIP]` (to indicate a work in progress). WIPs may be useful to (1) indicate you are working on something to avoid duplicated work, (2) request broad review of functionality or API, or (3) seek collaborators.
100102

0 commit comments

Comments
 (0)