-
Notifications
You must be signed in to change notification settings - Fork 100
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
Adding an issue_template.md #101
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us debug, it would be nice to fill the template as much as you can to help us, help you and help us all. | ||
|
||
--- | ||
|
||
**How to post a meaningful bug report** | ||
1. *Read this whole template first.* | ||
2. *Determine if you are on the right place:* | ||
- *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change url...), you are on the right place!* | ||
- *Otherwise, the issue may be due to REPLACEBYYOURAPP itself. Refer to its documentation or repository for help.* | ||
- *If you have a doubt, post here, we will figure it out together.* | ||
3. *Delete the italic comments as you write over them below, and remove this guide.* | ||
--- | ||
|
||
**Describe the bug** | ||
*A clear and concise description of what the bug is.* | ||
|
||
**Versions** | ||
- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* | ||
- YunoHost version: x.x.x | ||
- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* | ||
- Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: *no / yes* | ||
- If yes, please explain: | ||
- Using, or trying to install package version/branch: | ||
- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* | ||
|
||
**To Reproduce** | ||
*Steps to reproduce the behavior.* | ||
- *If you performed a command from the CLI, the command itself is enough. For example:* | ||
```sh | ||
sudo yunohost app install REPLACEBYYOURAPP | ||
``` | ||
- *If you used the webadmin, please perform the equivalent command from the CLI first.* | ||
- *If the error occurs in your browser, explain what you did:* | ||
1. *Go to '...'* | ||
2. *Click on '....'* | ||
3. *Scroll down to '....'* | ||
4. *See error* | ||
|
||
**Expected behavior** | ||
*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* | ||
|
||
**Logs** | ||
*After a failed command, YunoHost makes the log available to you, but also to others, thanks to `yunohost log display [log name] --share`. The actual command, with the correct log name, is displayed at the end of the failed attempt in the CLI. Execute it and copy here the share link it outputs.* | ||
*If applicable and useful, add screenshots to help explain your problem.* |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Naively I'd put this bit right after "Describe the bug" but idk ;P
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
idk too... But asking at that point, after the user provided the steps to reproduce the issue, maybe it can reduce the number of issues opened,