Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 11771ec2 authored by Romain Hunault's avatar Romain Hunault 💻
Browse files

Merge branch '101-correcting-errors-in-report-an-issue-page' into 'master'

Resolve "Correcting errors in Report an issue page"

Closes #101

See merge request e/documentation/user!86
parents 5e77f1d5 eef3fb28
Loading
Loading
Loading
Loading
+67.6 KiB
Loading image diff...
+17 −38
Original line number Diff line number Diff line
@@ -7,58 +7,37 @@ search: exclude

What to do when you encounter an issue?

## 1. Connect to our GitLab server:
### 1. Connect to our GitLab server

* If you have an account, [login](https://gitlab.e.foundation/users/sign_in)
* If not, [create one](https://gitlab.e.foundation/e)

## 2. Go to our issue board:
### 2. Go to our issue dashboard

/e/ issues are listed here: https://gitlab.e.foundation/groups/e/-/issues
- /e/ issues are listed and created [here](https://gitlab.e.foundation/e/backlog/-/issues)

Before doing anything, please check if someone already created an issue about the problem you have encountered.
- Before creating a new issue, please search if it has previously been reported. To check for this

1. *"My problem is already described."* You can add some missing information to help developers: how you got the issue, steps to reproduce.
1. *"Nobody has reported my issue."* In this case, create a new one!
- Type the bug in the search text box on the top of the screen as shown below

At the top right of the page, click **Select project to create an issue** and choose **e/management**. Then, click **New issue in management**.
![New Search](../../../images/new_issue_search.png)

![Capture_du_2018-09-10_12-31-38](images/Capture_du_2018-09-10_12-31-38.png)
- The screen will also display some other similar worded issues

> If you are sure that your issue is related to a specific project, please report the issue within the given project.
- If this search does not return any results create a new issue

## 3. Create a new issue
### 3. Create a new issue

Please copy/paste the following template, and fill it by adding the title and fill in each part with related information.
- Select a template for the issue from the drop down marked 'Choose a template'
- 'Apply template'
- Add a Title
- Fill in all the details as requested in the template
- Always [add logs](https://community.e.foundation/t/howto-get-a-log-from-your-phone/2366) where possible. This helps the developers debug the issue better.
- Once you have finished, click **Submit issue**.

```markdown
## Summary
(Summarize the bug encountered, briefly and precisely)

## Steps to reproduce
(How one can reproduce the issue - this is very important)

## What is the current behavior?
(What actually happens)

## What is the expected correct behavior?
(What you should see instead)

## Relevant logs and/or screenshots
(Paste any relevant logs - please use code blocks (```) to format console output,
logs, and code as it's very hard to read otherwise.)
(You can use `adb logcat` command to capture log of you device, when connected to a computer)

## Possible fixes
(If you can, link to the line of code that might be the cause for this problem)

```

Once you have finished, you can create your issue by clicking **Submit issue**.

Source : https://docs.gitlab.com/ee/user/project/description_templates.html#setting-a-default-template-for-issues-and-merge-requests

## 4. Syntax
### 4. Syntax and Source

* [Source](https://docs.gitlab.com/ee/user/project/description_templates.html#setting-a-default-template-for-issues-and-merge-requests)
* [Markdown (GitLab)](https://docs.gitlab.com/ee/user/markdown.html)
* [Markdown Guide  (GitLab)](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/)