ubports/ubuntu-touch
1
1
Fork 0
mirror of https://github.com/ubports/ubuntu-touch.git synced 2024-07-07 07:16:31 +03:00
Code Issues Projects Releases Wiki Activity

Update

Browse Source 
To counter the low-quality issues, the readme and contributing file have been updated to include a reference to the all-new bugreporting guide: https://docs.ubports.com/en/latest/contribute/bugreporting.html

Also, the issue template has been updated to include some comments and a template for feature-requests.

Additionally, the code-of-conduct and support files were created.
This commit is contained in:
neothethird 2017-12-19 02:25:29 +01:00
parent ede94e8f55
commit 6b3b3a8819
6 changed files with 100 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1 @@
By contributing to this repository you agree to the [Ubuntu Code of Conduct](https://www.ubuntu.com/about/about-ubuntu/conduct).

74
CONTRIBUTING.md
View File

@ -1,73 +1,3 @@
This page contains information to help you help us reporting an actionable bug for Ubuntu Touch. It does NOT contain information on reporting bugs in apps, most of the time their entry in the OpenStore will specify where and how to do that.
Please read our [guide on writing a good bug report](https://docs.ubports.com/en/latest/contribute/bugreporting.html) before creating a new issue. To better understand the lifecycle of your issue, refer to our [issue tracking guidelines](https://docs.ubports.com/en/latest/about/process/issue-tracking.html).
## Make sure you're on the latest version of the OS
This might seem obvious, but it's easy to miss. Go to (Settings - Updates) and make sure that your device doesn't have any Ubuntu updates. If not, continue through this guide. If so, update your device and try to reproduce the bug. If it still occurs, continue through this guide. If not, do a little dance! The bug has already been fixed and you can continue using Ubuntu Touch.
## Check if the bug report already exists
Open up the bug tracker for [ubuntu-touch](https://github.com/ubports/ubuntu-touch).
First, you'll need to make sure that the bug you're trying to report hasn't been reported before. Search through the bugs reported. When searching, use a few words that describe what you're seeing. For example, "Lock screen transparent" or "Lock screen shows activities".
If you find that a bug report already exists, select the "Add your Reaction" button (it looks like a smiley face) and select the +1 (thumbs up) reaction. This shows that you are also experiencing the bug.
If the report is missing any of the information specified later in this document, please add it yourself to help the developers fix the bug.
## Reproduce the issue you've found
Next, find out exactly how to recreate the bug that you've found. Document the exact steps that you took to find the problem in detail. Then, reboot your phone and perform those steps again. If the problem still occurs, continue on to the next step. [If not...](https://youtu.be/nn2FB1P_Mn8?t=10s)
## Getting Logs
We appreciate as many good logs as we can get when you report a bug. In general, `/var/log/dmesg` and the output of `/android/system/bin/logcat` are helpful when resolving an issue. I'll show you how to get these logs.
To get set up, follow these steps:
1. Reboot your device
1. Place your device into developer mode (Settings - About - Developer Mode - check the box to turn it on)
1. When you're done getting logs from your device, it's a good idea to turn Developer Mode off again.
1. Plug the device into a computer with `adb` installed
1. Open a terminal and run `adb devices`.
If there's a device in the list here (The command doesn't print "List of devices attached" and a blank line), continue on. If there is not, try following these steps again then contact us at one of our support channels.
Now, you can get the two most important logs.
### dmesg
1. Using the steps you documented earlier, reproduce the issue you're reporting
1. `cd` to a folder where you're able to write the log
1. Delete the file `UTdmesg.log` if it exists
1. Run the command: `adb shell "dmesg" > "UTdmesg.txt"`
This log should now be located at `UTdmesg.txt` under your working directory, ready for uploading later.
### logcat
1. Using the steps you documented earlier, reproduce the issue you're reporting
1. `cd` to a folder where you're able to write the log
1. Delete the file `UTlogcat.log` if it exists
1. Run the command: `adb shell "/android/system/bin/logcat -d" > "UTlogcat.txt"`
This log will be located at `UTlogcat.txt` in your current working directory, so you'll be able to upload it later.
## Making the bug report
Now it's time for what you've been waiting for, the bug report itself!
First, pull up the bug tracker and click "New Issue". Log in to GitHub if you haven't yet.
Next, you'll need to name your bug. Pick a name that says what's happening, but don't be too wordy. Four to eight words should be enough.
Now, write your bug report. A good bug report includes the following:
* **What happened**: A synopsis of the erroneous behavior
* **What I expected to happen**: A synopsis of what should have happened, if there wasn't an error
* **Steps to reproduce**: You wrote these down earlier, right?
* **Logs**: Attach your logs by clicking and dragging them into your GitHub issue.
* **Software Version**: Go to (Settings - About) and list what appears on the "OS" line of this screen. Also include the release channel that you used when you installed Ubuntu on this phone.
Once you're finished with that, post the bug. You'll get the option to add tags, so add the tag for the device you're experiencing the issue on.
A developer or triager will confirm and triage your bug, then work can begin on it. If you are missing any information, you will be asked for it, so make sure to check in often!
Want to get involved and help with testing and qa? [Here's how](https://docs.ubports.com/en/latest/contribute/quality-assurance.html).

57
ISSUE_TEMPLATE.md
View File

@ -1,21 +1,56 @@
<!------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Thank you for wanting to file an issue! If you have a minute, please take the time to read our guide on writing a good bug-report:
https://docs.ubports.com/en/latest/contribute/bugreporting.html
If not and you just want to get this over with, that's also quite alright. But please try to format your issue correctly, to make it easier for us to read. Below, we provide a template for a feature-request and a bug-report. Use common sense to determine what category your issue falls under and delete the template you don't need. Also, you don't need to stick to the templates under all circumstances. If you don't need a heading, remove it. If you think a new section will provide valuable information, add a new heading. We're not dogmatists, we're pragmatists who just want to be able to efficiently work with new issues.
--------------------------------------------------------------------------------
------------------------------------------------------------------------------->
<!------------------------------------------------------------------------------
-------- FEATURE-REQUEST -------------------------------------------------------
--------------------------------------------------------------------------------
-------- You're missing a feature in Ubuntu Touch that other operating ---------
-------- systems offer or that you think will just be very useful? -------------
-------- Sounds like you'll want to file a feature-request. --------------------
--------------------------------------------------------------------------------
------------------------------------------------------------------------------->
### Description of the feature
<!-- Describe what feature you'd like to see -->
### Illustrations
<!-- Are you ripping of another product? Maybe provide a screenshot to illustrate. -->
<!-- Are you a UI-Designer? Create a nice mockup to show what it could look like -->
<!-- Are you hilariously bad at drawing? Ok, then just delete this subsection. -->
<!------------------------------------------------------------------------------
-------- BUG-REPORT ------------------------------------------------------------
--------------------------------------------------------------------------------
-------- Something doesn't work the way you want it? That's a bug. -------------
--------------------------------------------------------------------------------
------------------------------------------------------------------------------->
- Device:
- Channel:
- Build:
## Steps to reproduce
### Steps to reproduce
<!-- Describe what causes your bug to occur -->
1. ...
2. ...
3. ...
## Expected behavoir
### Expected behavoir
<!-- Describe what you'd expect to happen -->
...
## Actual behavior
### Actual behavior
<!-- Describe what actually happens instead -->
...
## Logfiles and additional information
...
### Logfiles and additional information
<!-- https://docs.ubports.com/en/latest/contribute/bugreporting.html#getting-logs -->

28
PULL_REQUEST_TEMPLATE.md Normal file
View File

@ -0,0 +1,28 @@
### Requirements
* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* All new code requires tests to ensure against regressions
### Description of the Change
<!--
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
-->
### Benefits
<!-- What benefits will be realized by the code change? -->
### Possible Drawbacks
<!-- What are the possible side-effects or negative impacts of the code change? -->
### QA-Steps
<!-- How can we make sure your change works? What should we look out for? -->
### Related Issues
<!-- Enter any related Issues here -->

34
README.md
View File

@ -9,26 +9,23 @@
This is where we track all [bugs](https://github.com/ubports/ubports-touch/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and [feature-request](https://github.com/ubports/ubuntu-touch/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22+) for the operating system.
Please make sure that you're in [in the right place](https://wiki.ubports.com/wiki/UBports-Bug-Trackers) and read the [guide on writing a good bug report](https://docs.ubports.com/en/latest/contribute/bugreporting.html) before filing a new issue. Thank you!
Please read our [guide on writing a good bug report](https://docs.ubports.com/en/latest/contribute/bugreporting.html) before creating a new issue. To better understand the lifecycle of your issue, refer to our [issue tracking guidelines](https://docs.ubports.com/en/latest/about/process/issue-tracking.html). Thank you!
### Shortcut to issue milestones
[Issue Milestones](https://github.com/ubports/ubuntu-touch/milestones)
### Tags and Filtering
[Milestones](https://github.com/ubports/ubuntu-touch/milestones). [What's the policy](https://docs.ubports.com/en/latest/about/process/issue-tracking.html#milestones)?
You can use GitHub's filtering syntax to reduce clutter. Here's a brief explaination of the tags and what they mean:
### Labels and Filtering
#### General
You can use GitHub's filtering syntax to reduce clutter. [Here's a brief explaination of the standard labels and what they mean](https://docs.ubports.com/en/latest/about/process/issue-tracking.html#labels).
- [needs confirmation](https://github.com/ubports/ubuntu-touch/labels/needs%20confirmation): This issue needs confirmation and triage.
- [bug](https://github.com/ubports/ubports-touch/labels/bug): This issue is a confirmed bug.
- [feature request](https://github.com/ubports/ubuntu-touch/labels/feature%20request): This issue is a feature request.
- [opinion](https://github.com/ubports/ubports-touch/labels/opinion): This issue is polarizing or needs further discussion.
- [question](https://github.com/ubports/ubports-touch/labels/question): This issue is a support request or general question.
- [invalid](https://github.com/ubports/ubports-touch/labels/invalid): This issue is incomplete, can not be confirmed, or was reported in the wrong place.
- [duplicate](https://github.com/ubports/ubports-touch/labels/duplicate): This has already been reported somewhere else. Please provide a link.
- [help wanted](https://github.com/ubports/ubports-touch/labels/help%20wanted): Looking for something to do? Start here.
- [wontfix](https://github.com/ubports/ubports-touch/labels/wontfix): It does not make sense to fix this bug, since it will probably resolve itself, it will be too much work to fix it, it's not fixable or an underlying component will soon change. Depending on the case, pull-requests are welcome. Look out for the [help wanted](https://github.com/ubports/ubports-touch/labels/help%20wanted) tag.
Additionally, the following special labels are used:
#### Critical
- [critical (devel)](https://github.com/ubports/ubuntu-touch/labels/critical%20%28devel%29): This critical issue that only occurs on the devel channel is blocking the release of the next rc image.
- [critical (rc)](https://github.com/ubports/ubuntu-touch/labels/critical%20%28rc%29): This critical issue that only occurs on the devel and rc channel is blocking the release of the next stable release. Usually, issues that can not simply be moved to a different release and have the power to postpone the release are labeled this.
#### Devices
@ -47,6 +44,11 @@ You can use GitHub's filtering syntax to reduce clutter. Here's a brief explaina
- [device: vegetahd](https://github.com/ubports/ubports-touch/labels/device%3A%20vegetahd): This issue affects the Bq E5.
- [device: w7](https://github.com/ubports/ubports-touch/labels/device%3A%20w7): This issue affects the LG L90.
#### Pull Requests
#### Team
- [Pending and closed Pull Requests](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+user%3Aubports): Shortcut to what others are contributing
- [team: ui](https://github.com/ubports/ubports-touch/labels/team%3A%20ui): This issue falls under the responsibility of the user-interface team.
- [team: ui](https://github.com/ubports/ubports-touch/labels/team%3A%20middleware): This issue falls under the responsibility of the middleware team.
- [team: hal](https://github.com/ubports/ubports-touch/labels/team%3A%20hal): This issue falls under the responsibility of the hardware abstraction layer team.
---
This is repository does not contain the actual Ubuntu Touch code. Duh.

5
SUPPORT.md Normal file
View File

@ -0,0 +1,5 @@
Support requests are generally tolerated here, especially if it's unclear if an issue may be a bug or a missing feature. Though, in most cases there are more efficient ways of getting support.
- The [docs](docs.ubports.com) cover a wide array of typical problems and situations users might find themselves in.
- The community offers support in the [forum](forums.ubports.com).
- For real-time chat (english), you can join our [Telegram Supergroup](t.me/ubports) or [Matrix Room](https://matrix.to/#/#ubports:matrix.org).