10000 Adding a new article about "Creating a Bug Reproducer" by javiereguiluz · Pull Request #7645 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Adding a new article about "Creating a Bug Reproducer" #7645

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

Closed
wants to merge 2 commits into from

Conversation

javiereguiluz
Copy link
Member

It's very common for us to tell issue reportes to create a bug reproducer. We usually tell them "fork the Symfony Standard edition and reproduce the bug" ... but I don't like that and I'm sure that most people don't understand what we're talking about.

I propose to add this article to explain as simple as possible what do we expect them to do, so we can link to this article in every issue of the Symfony code repo.


If you are thinking about merging this article with others of the "Contributing" section ... let's do that later. I want to change a lot of things here ... but let's do one thing at a time. Thanks!

Copy link
Member
@yceruto yceruto left a comment

Choose a reason for hiding this comment

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

👍 Excellent idea!

Also, other people's clone the Symfony repository and add a test to reproduce the bug or the wrong behavior. Sure, it's more advanced but a bit faster.

// First, run "composer require symfony/validator"
// Then, execute this file:
<?php
require_once __DIR__.'/../vendor/autoload.php';
Copy link
Member
@yceruto yceruto Mar 17, 2017

Choose a reason for hiding this comment

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

The path to the autoload.php should be __DIR__.'/vendor/autoload.php' (if composer.lock and PHP script are in the same dir).

@yceruto
Copy link
Member
yceruto commented Mar 17, 2017

Casually I had left a comment in "Symfony Community Survey 2017" related to this idea of making viable the way to reproduce issues through a fiddle application with support to install the needed vendors and run/share it. The first part, by using a PHP script to test Symfony components would work perfectly (with some initial code templates to start).

It is my proof idea: https://phpcomposerfiddle.herokuapp.com (nonprofit) ❤️ 🆘

@javiereguiluz
Copy link
Member Author

I think it's a good idea to link to Twig's fiddle and this Symfony's fiddle when they are ready (Twig one seems mature, but the other one is still too new).

@xabbuh
Copy link
Member
xabbuh commented Mar 17, 2017

👍 for this idea

Copy link
Contributor
@HeahDude HeahDude left a comment

Choose a reason for hiding this comment

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

Awesome!

@xabbuh
Copy link
Member
xabbuh commented Apr 15, 2017

Thank you @javiereguiluz.

xabbuh added a commit that referenced this pull request Apr 15, 2017
…aviereguiluz)

This PR was squashed before being merged into the 2.7 branch (closes #7645).

Discussion
----------

Adding a new article about "Creating a Bug Reproducer"

It's very common for us to tell issue reportes to create a bug reproducer. We usually tell them *"fork the Symfony Standard edition and reproduce the bug"* ... but I don't like that and I'm sure that most people don't understand what we're talking about.

I propose to add this article to explain as simple as possible what do we expect them to do, so we can link to this article in every issue of the Symfony code repo.

---

If you are thinking about merging this article with others of the "Contributing" section ... let's do that later. I want to change a lot of things here ... but let's do one thing at a time. Thanks!

Commits
-------

b5a61ca Adding a new article about "Creating a Bug Reproducer"
xabbuh added a commit that referenced this pull request Apr 15, 2017
@xabbuh xabbuh closed this Apr 15, 2017
xabbuh added a commit that referenced this pull request Apr 15, 2017
* 2.7: (31 commits)
  Fixed the RST syntax
  Improve example context
  [#5621] Enhancing example of using bundle config
  [#7601] minor tweak
  Update expiration.rst
  Update expiration.rst
  Update expiration.rst
  Update expiration.rst
  Minor reword and fixed the line length
  Improve specification explanation
  [#7664] minor wording tweak
  Rewords and minor fixes
  Add an explanation about «constraints» validation
  [#7645] enumerate ordered list items implicitly
  Adding a new article about "Creating a Bug Reproducer"
  Fixed a syntax issue
  Use backticks
  #7311 choice_value callback argument can be null
  Fixed broken links for nginx & FastCgiExternalServer
  Update dialoghelper.rst
  ...
xabbuh added a commit that referenced this pull request Apr 15, 2017
* 2.8: (46 commits)
  [#7507] fix component name
  [#7490] minor typo fix
  Added a note about redirections to absolute URLs in tests
  Added the changes suggested by reviewers
  [#7620] use generate() in PHP templates before 2.8
  Fixed the RST syntax
  Improve example context
  [#5621] Enhancing example of using bundle config
  [#7601] minor tweak
  Update expiration.rst
  Update expiration.rst
  Update expiration.rst
  Update expiration.rst
  Minor reword and fixed the line length
  Improve specification explanation
  [#7664] minor wording tweak
  Rewords and minor fixes
  Add an explanation about «constraints» validation
  [#7645] enumerate ordered list items implicitly
  Adding a new article about "Creating a Bug Reproducer"
  ...
@javiereguiluz javiereguiluz deleted the issue_reproducer branch May 24, 2018 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
0