Skip to content

Commit 793e8e1

Browse files
[MRG] Templates (#181)
* Add a PR template * move github contrib + code of conduct * fix links * add feature request template * ask for gpu info * address comments * add gitter in README
1 parent 88df6e2 commit 793e8e1

File tree

6 files changed

+84
-18
lines changed

6 files changed

+84
-18
lines changed
File renamed without changes.
File renamed without changes.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,42 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve POT
4+
title: ''
5+
labels: bug, help wanted
6+
assignees: ''
47

58
---
69

7-
**Describe the bug**
8-
A clear and concise description of what the bug is.
10+
## Describe the bug
11+
<!-- A clear and concise description of what the bug is. -->
912

10-
**To Reproduce**
13+
### To Reproduce
1114
Steps to reproduce the behavior:
12-
1 ...
15+
1. ...
1316
2.
1417

15-
**Expected behavior**
16-
A clear and concise description of what you expected to happen.
18+
<!-- If you have error messages or stack traces, please provide it here as well -->
1719

18-
**Screenshots**
19-
If applicable, add screenshots to help explain your problem.
20+
#### Screenshots
21+
<!-- If applicable, add screenshots to help explain your problem. -->
2022

21-
**Desktop (please complete the following information):**
22-
- OS: [e.g. MacOSX, Windows, Ubuntu]
23-
- Python version [2.7,3.6]
24-
- How was POT installed [source, pip, conda]
23+
#### Code sample
24+
<!-- Ideally attach a minimal code sample to reproduce the decried issue.
25+
Minimal means having the shortest code but still preserving the bug. -->
26+
27+
### Expected behavior
28+
<!-- A clear and concise description of what you expected to happen. -->
29+
30+
31+
### Environment (please complete the following information):
32+
- OS (e.g. MacOS, Windows, Linux):
33+
- Python version:
34+
- How was POT installed (source, `pip`, `conda`):
35+
- Build command you used (if compiling from source):
36+
- Only for GPU related bugs:
37+
- CUDA version:
38+
- GPU models and configuration:
39+
- Any other relevant information:
2540

2641
Output of the following code snippet:
2742
```python
@@ -32,5 +47,5 @@ import scipy; print("SciPy", scipy.__version__)
3247
import ot; print("POT", ot.__version__)
3348
```
3449

35-
**Additional context**
36-
Add any other context about the problem here.
50+
### Additional context
51+
<!-- Add any other context about the problem here. -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement, feature request
6+
assignees: ''
7+
8+
---
9+
10+
## 🚀 Feature
11+
<!-- A clear and concise description of the feature proposal -->
12+
13+
### Motivation
14+
<!-- Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too -->
15+
16+
### Pitch
17+
<!-- A clear and concise description of what you want to happen. -->
18+
19+
### Alternatives
20+
<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
21+
22+
### Additional context
23+
<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Types of changes
2+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
3+
4+
- [ ] Docs change / refactoring / dependency upgrade
5+
- [ ] Bug fix (non-breaking change which fixes an issue)
6+
- [ ] New feature (non-breaking change which adds functionality)
7+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
8+
9+
10+
## Motivation and context / Related issue
11+
<!--- Why is this change required? What problem does it solve? -->
12+
<!--- Please link to an existing issue here if one exists. -->
13+
<!--- (we recommend to have an existing issue for each pull request) -->
14+
15+
16+
## How has this been tested (if it applies)
17+
<!--- Please describe here how your modifications have been tested. -->
18+
19+
20+
## Checklist
21+
<!-- - Go over all the following points, and put an `x` in all the boxes that apply. -->
22+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
23+
24+
- [ ] The documentation is up-to-date with the changes I made.
25+
- [ ] I have read the [**CONTRIBUTING**](CONTRIBUTING.md) document.
26+
- [ ] All tests passed, and additional code has been covered with new tests.
27+
28+
<!--- In any case, don't hesitate to join and ask questions if you need on slack (https://pot-toolbox.slack.com/), gitter (https://gitter.im/PythonOT/community), or the mailing list (https://mail.python.org/mm3/mailman3/lists/pot.python.org/). -->

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,17 +190,17 @@ This toolbox benefit a lot from open source research and we would like to thank
190190

191191
## Contributions and code of conduct
192192

193-
Every contribution is welcome and should respect the [contribution guidelines](CONTRIBUTING.md). Each member of the project is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
193+
Every contribution is welcome and should respect the [contribution guidelines](.github/CONTRIBUTING.md). Each member of the project is expected to follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
194194

195195
## Support
196196

197197
You can ask questions and join the development discussion:
198198

199-
* On the [POT Slack channel](https://pot-toolbox.slack.com)
199+
* On the POT [slack channel](https://pot-toolbox.slack.com)
200+
* On the POT [gitter channel](https://gitter.im/PythonOT/community)
200201
* On the POT [mailing list](https://mail.python.org/mm3/mailman3/lists/pot.python.org/)
201202

202-
203-
You can also post bug reports and feature requests in Github issues. Make sure to read our [guidelines](CONTRIBUTING.md) first.
203+
You can also post bug reports and feature requests in Github issues. Make sure to read our [guidelines](.github/CONTRIBUTING.md) first.
204204

205205
## References
206206

0 commit comments

Comments
 (0)