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.

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

Provide scripts to reproduce errors for each backend #746

Closed
MaxGabriel opened this issue Nov 26, 2017 · 0 comments
Closed

Provide scripts to reproduce errors for each backend #746

MaxGabriel opened this issue Nov 26, 2017 · 0 comments

Comments

@MaxGabriel
Copy link
Member

It's super helpful when issues include a reproducing case, and we should make that as easy as possible. I think we should provide a small template for each backend (either different scripts, or one script with preprocessor macros to specify the backend, but that might be too complicated). This would be especially helpful because most Persistent users are using Persistent in the context of a big web app.

We could then link to those issues in a CONTRIBUTING.md doc or .github/ISSUE_TEMPLATE.md file.

ActiveRecord for example provides this script:
https://github.com/rails/rails/blob/master/guides/bug_report_templates/active_record_master.rb

MaxGabriel added a commit that referenced this issue Dec 31, 2017
This PR is the Persistent version of yesodweb/yesod#1451

It makes some small changes for Persistent, but is generally pretty similar.

A major change is that I've created templates for the MySQL, Postgres, SQLite and MongoDB backends to help users create small scripts to reproduce issues.

(As a side note, I think that documentation for getting a minimal running setup for each backend is lacking and these scripts should be adapted into such documentation).

The scripts themselves could especially use reviewing since the contributing guidelines have already been merged into yesod and wai.

Closes #746
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant