Skip to content

[MRG+1] add github issues buttons #316

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

Merged
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
12 changes: 12 additions & 0 deletions .github/issue_template.md → .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
name: Reproducible bug report
about: Create a reproducible bug report. Not for support requests.
labels: 'bug'
---

#### Description
<!-- Describe your issue here.-->

Expand Down Expand Up @@ -42,3 +48,9 @@ $ pip show metric_learn | grep Version
)
-->
<!-- Thanks for contributing! -->

---
<!-- Issue Author: Don't delete this message to encourage other users to support your issue! -->
**Message from the maintainers**:

Impacted by this bug? Give it a 👍. We prioritise the issues with the most 👍.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
blank_issues_enabled: false

contact_links:
- name: Have you read the docs?
url: http://contrib.scikit-learn.org/metric-learn/
about: Much help can be found in the docs
- name: Ask a question
url: https://github.com/sklearn-contrib/metric-learn/discussions/new
about: Ask a question or start a discussion about metric-learn
- name: Stack Overflow
url: https://stackoverflow.com
about: Please ask and answer metric-learn usage questions (API, installation...) on Stack Overflow
- name: Cross Validated
url: https://stats.stackexchange.com
about: Please ask and answer metric learning questions (use cases, algorithms & theory...) on Cross Validated
- name: Blank issue
url: https://github.com/sklearn-contrib/metric-learn/issues/new
about: Please note that Github Discussions should be used in most cases instead
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This template can be removed as it's not used.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Precisely, I was thinking it could be a good time to create a template for doc issues (and have the corresponding button), what do you think ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me.

name: Documentation improvement
about: Create a report to help us improve the documentation. Alternatively you can just open a pull request with the suggested change.
labels: Documentation
---

#### Describe the issue linked to the documentation

<!--
Tell us about the confusion introduced in the documentation.
-->

#### Suggest a potential alternative/fix

<!--
Tell us how we could improve the documentation in this regard.
-->

---
<!-- Issue Author: Don't delete this message to encourage other users to support your issue! -->
**Message from the maintainers**:

Confused by this part of the doc too? Give it a 👍. We prioritise the issues with the most 👍.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Enhancement proposal
about: Propose an enhancement for metric-learn
labels: 'enhancement'
---
# Summary

What change needs making?

# Use Cases

When would you use this?

---
<!-- Issue Author: Don't delete this message to encourage other users to support your issue! -->
**Message from the maintainers**:

Want to see this feature happen? Give it a 👍. We prioritise the issues with the most 👍.