Changeset View
Changeset View
Standalone View
Standalone View
src/docs/contributor/reproduction_steps.diviner
| Show First 20 Lines • Show All 106 Lines • ▼ Show 20 Lines | |||||
| instance on Phacility in about 60 seconds (see the "Resources" section for | instance on Phacility in about 60 seconds (see the "Resources" section for | ||||
| details). | details). | ||||
| If you can follow your steps and reproduce the issue on a clean instance, | If you can follow your steps and reproduce the issue on a clean instance, | ||||
| we'll probably be able to follow them and reproduce the issue ourselves. | we'll probably be able to follow them and reproduce the issue ourselves. | ||||
| If you can't follow your steps because they depend on information which is not | If you can't follow your steps because they depend on information which is not | ||||
| available on a clean instance (for example, a certain config setting), rewrite | available on a clean instance (for example, a certain config setting), rewrite | ||||
| them to include instrutions to create that information (for example, adjusting | them to include instructions to create that information (for example, adjusting | ||||
| the config to the problematic value). | the config to the problematic value). | ||||
| If you follow your instructions but the issue does not reproduce, the issue | If you follow your instructions but the issue does not reproduce, the issue | ||||
| might already be fixed. Make sure your install is up to date. | might already be fixed. Make sure your install is up to date. | ||||
| If your install is up to date and the issue still doesn't reproduce on a clean | If your install is up to date and the issue still doesn't reproduce on a clean | ||||
| install, your reproduction steps are missing important information. You need to | install, your reproduction steps are missing important information. You need to | ||||
| figure out what key element differs between your install and the clean install. | figure out what key element differs between your install and the clean install. | ||||
| ▲ Show 20 Lines • Show All 62 Lines • ▼ Show 20 Lines | |||||
| smaller case which reproduces the problem, which might be something like this: | smaller case which reproduces the problem, which might be something like this: | ||||
| - Files like `a b`, which contain spaces, do not work. | - Files like `a b`, which contain spaces, do not work. | ||||
| - Files like `a.doc`, which have the `.doc` extension, do not work. | - Files like `a.doc`, which have the `.doc` extension, do not work. | ||||
| - Files like `AAAAAAAAAA`, which have more than 9 letters, do not work. | - Files like `AAAAAAAAAA`, which have more than 9 letters, do not work. | ||||
| - Files like `A`, which have uppercase letters, do not work. | - Files like `A`, which have uppercase letters, do not work. | ||||
| With a simpler reproduction scenario, you can simplify your steps to be more | With a simpler reproduction scenario, you can simplify your steps to be more | ||||
| tailored and mimimal. This will help us pointpoint the issue more quickly and | tailored and minimal. This will help us pinpoint the issue more quickly and | ||||
| be more certain that we've understood and resolved it. | be more certain that we've understood and resolved it. | ||||
| It is more important that steps be complete than that they be simple, and it's | It is more important that steps be complete than that they be simple, and it's | ||||
| acceptable to submit complex instructions if you have difficulty simplifying | acceptable to submit complex instructions if you have difficulty simplifying | ||||
| them, so long as they are complete, self-contained, and accurately reproduce | them, so long as they are complete, self-contained, and accurately reproduce | ||||
| the issue. | the issue. | ||||
| ▲ Show 20 Lines • Show All 50 Lines • Show Last 20 Lines | |||||