Skip to content
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.

Sign up for GitHub

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

Jump to bottom

How to approach Bugs? - Documentation #1820

Closed
rt4914 opened this issue Sep 8, 2020 · 3 comments · Fixed by #4957
Closed

How to approach Bugs? - Documentation #1820

rt4914 opened this issue Sep 8, 2020 · 3 comments · Fixed by #4957
Assignees
@MohitGupta121
Labels
enhancement End user-perceivable enhancements. Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Priority: Nice-to-have This work item is nice to have for its milestone. Z-ibt Temporary label for Ben to keep track of issues he's triaged.

Comments

@rt4914
Copy link
Contributor

rt4914 commented Sep 8, 2020

We should mention in wiki about how we should approach a bug by following below mentioned points:

  1. First try to find the exact reasons of the bugs.
  2. Once you have identified the reason, write a test case which actually fails because of the bug. (This will be needed in future).
  3. Now work towards solution.
  4. Now, the test cases which were written in (2.) should pass and that way we can be sure that the bug has been fixed.
    So at this stage you should focus on step 1.
@rt4914 rt4914 added Priority: Nice-to-have This work item is nice to have for its milestone. Status: Not started labels Sep 8, 2020
@rt4914 rt4914 added this to the Backlog milestone Sep 8, 2020
@BenHenning
Copy link
Member

I was going to suggest you add this as documentation after seeing you give this advice on the other thread. Probably worth prioritizing this as part of the onboarding workflow.

@rt4914 rt4914 self-assigned this Sep 9, 2020
@rt4914 rt4914 removed their assignment Jan 18, 2022
@Broppia Broppia added issue_type_infrastructure Impact: Low Low perceived user impact (e.g. edge cases). labels Jul 29, 2022
@BenHenning BenHenning added Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Z-ibt Temporary label for Ben to keep track of issues he's triaged. issue_user_developer and removed Impact: Low Low perceived user impact (e.g. edge cases). labels Sep 15, 2022
@BenHenning BenHenning removed this from the Backlog milestone Sep 16, 2022
@seanlip
Copy link
Member

seanlip commented Mar 28, 2023

@MohitGupta121 PTAL and triage for the wiki updates as needed. Thanks!

@seanlip seanlip added enhancement End user-perceivable enhancements. and removed issue_type_infrastructure labels Mar 28, 2023
@MohitGupta121
Copy link
Member

@seanlip sure, I will add this in my list.

@MohitGupta121 MohitGupta121 mentioned this issue Apr 22, 2023
Merged
6 tasks
seanlip pushed a commit that referenced this issue Apr 26, 2023
@MohitGupta121
Fix #1820 : How to approach Bugs? - Documentation (#4957)
7e25274 
<!-- READ ME FIRST: Please fill in the explanation section below and
check off every point from the Essential Checklist! -->
## Explanation

Fix #1820 : How to approach Bugs? - Documentation

<!--
- Explain what your PR does. If this PR fixes an existing bug, please
include
- "Fixes #bugnum:" in the explanation so that GitHub can auto-close the
issue
  - when this PR is merged.
  -->

## Essential Checklist
<!-- Please tick the relevant boxes by putting an "x" in them. -->
- [x] The PR title and explanation each start with "Fix #bugnum: " (If
this PR fixes part of an issue, prefix the title with "Fix part of
#bugnum: ...".)
- [x] Any changes to
[scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets)
files have their rationale included in the PR explanation.
- [x] The PR follows the [style
guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide).
- [x] The PR does not contain any unnecessary code changes from Android
Studio
([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)).
- [x] The PR is made from a branch that's **not** called "develop" and
is up-to-date with "develop".
- [x] The PR is **assigned** to the appropriate reviewers
([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)).

## For UI-specific PRs only
<!-- Delete these section if this PR does not include UI-related
changes. -->
If your PR includes UI-related changes, then:
- Add screenshots for portrait/landscape for both a tablet & phone of
the before & after UI changes
- For the screenshots above, include both English and pseudo-localized
(RTL) screenshots (see [RTL
guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines))
- Add a video showing the full UX flow with a screen reader enabled (see
[accessibility
guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide))
- Add a screenshot demonstrating that you ran affected Espresso tests
locally & that they're passing
@github-project-automation github-project-automation bot moved this from Todo to Done in Developer Workflow Team Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MohitGupta121 MohitGupta121

Labels
enhancement End user-perceivable enhancements. Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Priority: Nice-to-have This work item is nice to have for its milestone. Z-ibt Temporary label for Ben to keep track of issues he's triaged.
Projects
Developer Workflow Team
Archived in project
[Team] Developer Workflow & Infrastructure - Android
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix #1820 : How to approach Bugs? - Documentation
5 participants
@rt4914 @seanlip @BenHenning @MohitGupta121 @Broppia