Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add issue template #730

Merged
merged 1 commit into from
Oct 10, 2019
Merged

Add issue template #730

merged 1 commit into from
Oct 10, 2019

Conversation

lbeaufort
Copy link
Contributor

@lbeaufort lbeaufort commented May 7, 2019 •
edited
Loading

Resolves #728

Flask-SQLAlchemy is a thin wrapper that combines Flask and SQLAlchemy. Please
make sure your issue is actually with Flask-SQLAlchemy and not SQLAlchemy before
submitting. Consider checking the traceback to see if the error is coming from SQLAlchemy,
or checking if your issue has already been reported as a SQLAlchemy issue on GitHub.

Also, please be kind - this project is maintained by volunteers. We appreciate
you taking the time to provide the information needed to address your issue.

rsyring
rsyring reviewed May 7, 2019
View reviewed changes
.github/ISSUE_TEMPLATE.md Outdated
@@ -0,0 +1,42 @@
**This issue tracker is a tool to address bugs in Flask-SQLAlchemy itself.
Please use the [#pocoo IRC channel on freenode](http://flask.pocoo.org/community/irc/) or [Stack Overflow](https://stackoverflow.com/questions/tagged/flask-sqlalchemy?sort=linked) for general
Copy link
Contributor

Choose a reason for hiding this comment

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

Is Freenode still a good place to point people? How about Discord?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

🤷‍♀ no opinion about Freednode, but I'm happy to add/replace with Discord. Is the best link https://discordapp.com/invite/t6rrQZH?

Copy link
Contributor

Choose a reason for hiding this comment

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

I honestly don't know. Let's see if @davidism or someone else who is more connected with Pallets than I am has a preference. If they don't give input, then I think we could just keep what you have.

rsyring
rsyring reviewed May 7, 2019
View reviewed changes
.github/ISSUE_TEMPLATE.md Outdated
@@ -0,0 +1,42 @@
**This issue tracker is a tool to address bugs in Flask-SQLAlchemy itself.
Copy link
Contributor

Choose a reason for hiding this comment

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

...to address bugs and feature requests...

rsyring
rsyring reviewed May 7, 2019
View reviewed changes
.github/ISSUE_TEMPLATE.md Outdated
Please use the [#pocoo IRC channel on freenode](http://flask.pocoo.org/community/irc/) or [Stack Overflow](https://stackoverflow.com/questions/tagged/flask-sqlalchemy?sort=linked) for general
questions about using Flask-SQLAlchemy or issues not related to Flask-SQLAlchemy.**

If you'd like to report a bug in Flask-SQLAlchemy, fill out the template below.
Copy link
Contributor

Choose a reason for hiding this comment

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

"...report a bug issue..."

It's not just bugs that would be appropriate.

rsyring
rsyring reviewed May 7, 2019
View reviewed changes
.github/ISSUE_TEMPLATE.md Outdated
your code.

Flask-SQLAlchemy is a thin wrapper that combines [Flask](https://github.com/pallets/flask) and [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy). Please check
if your issue has already been reported as a [SQLAlchemy issue on Github](https://github.com/sqlalchemy/sqlalchemy/issues).
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd leave this out:

Please check
if your issue has already been reported as a SQLAlchemy issue on Github.

And just say: "Please make sure your issue is actually with Flask-SQLAlchemy and not Flask or SQLAlchemy before submitting."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rsyring I hear what you're saying, but what's the action item for beginners?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I'm not exactly sure what you are asking. For a true beginner, IMO, they are likely to just make the issue post anyway b/c they don't really understand the layers or libraries involved. But for an intermediate or advanced user it serves as a reminder, hopefully, to double-check what the error is and try to make sure it's an FSA issue before submitting.

Maybe, it's to suggest they google for their issue with just "SQLAlchemy" and/or point them at the SQLAlchemy docs. My gut is, may problems people encounter with FSA end up really being SQLAlchemy usage errors.

Copy link
Contributor Author

@lbeaufort lbeaufort May 7, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe "Please make sure your issue is actually with Flask-SQLAlchemy and not SQLAlchemy before submitting. Consider checking the traceback to see if the error is coming from SQLAlchemy, or checking if your issue has already been reported as a SQLAlchemy issue on Github"

Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@rsyring
Copy link
Contributor

rsyring commented May 7, 2019

I made a few comments. It otherwise looks good IMO and is much better than what we currently have. ;)

@lbeaufort
Copy link
Contributor Author

@rsyring thank you for your review! I believe I've made all your requested changes if you don't mind taking a look.

@lbeaufort
Copy link
Contributor Author

Ah, sorry - I just pushed again to fix a broken link. I took creative license with some bolding if you don't mind taking a look.

kushthedude
kushthedude suggested changes Jul 27, 2019
View reviewed changes
.github/ISSUE_TEMPLATE.md
* Operating system:
* Python version:
* Flask-SQLAlchemy version:
* SQLAlchemy version:
Copy link
Contributor

Choose a reason for hiding this comment

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

@lbeaufort IMO, We should have a section for How To Reproduce the error, else lgtm

paxnovem
paxnovem approved these changes Oct 10, 2019
View reviewed changes
Copy link

@paxnovem paxnovem left a comment •
edited
Loading

Choose a reason for hiding this comment

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

These changes look good to get merged. 👍

For updating the discord link, I think that could be figured out with a small follow up PR. The irc channel is bridged with the discord channel (I think anyways), so it is not explicitly wrong. This is a big improvement overall.

@davidism davidism merged commit 2d61aa8 into pallets-eco:master Oct 10, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 5, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@rsyring rsyring rsyring left review comments

@kushthedude kushthedude kushthedude requested changes

@paxnovem paxnovem paxnovem approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create GitHub issue template for new issues
5 participants
@lbeaufort @rsyring @paxnovem @kushthedude @davidism