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

Fix #1820 : How to approach Bugs? - Documentation #4957

Merged
merged 5 commits into from
Apr 26, 2023
Merged

Fix #1820 : How to approach Bugs? - Documentation #4957

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4da5c47
Added approach for debugging
MohitGupta121 Apr 22, 2023
1575789
Merge branch 'develop' into debugging_wiki_approach
MohitGupta121 Apr 25, 2023
161b660
Updated Sean review changes
MohitGupta121 Apr 25, 2023
2b0d9e4
sidebar updated
MohitGupta121 Apr 25, 2023
f5ac995
Merge remote-tracking branch 'origin/debugging_wiki_approach' into de…
MohitGupta121 Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions wiki/Debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
We do a lot of debugging at Oppia-Android, whether because tests are failing on a PR or because of a tricky bug that was found during release testing. These guides will help you get started debugging and offer useful tips:
seanlip marked this conversation as resolved.
Show resolved Hide resolved

## How to approach Bugs?
1. First try to find the exact reasons of the bugs.
seanlip marked this conversation as resolved.
Show resolved Hide resolved
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 step 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.

Unless the bug you are trying to fix is trivial, we recommend creating a debugging doc to organize your work:
- [Debugging Docs](https://github.com/oppia/oppia-android/wiki/Get-Help#before-you-ask-a-general-question)
2 changes: 2 additions & 0 deletions wiki/_Sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
* [Ktlint Guide](https://github.com/oppia/oppia-android/wiki/Ktlint-Guide)
* [Static Analysis Checks](https://github.com/oppia/oppia-android/wiki/Static-Analysis-Checks)
* [Accessibility Guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)
* [Debugging](https://github.com/oppia/oppia-android/wiki/Debugging)
* [How to approach bugs](https://github.com/oppia/oppia-android/wiki/Debugging#how-to-approach-bugs)
* [Background Processing](https://github.com/oppia/oppia-android/wiki/Background-Processing)
* [Kotlin Coroutines](https://github.com/oppia/oppia-android/wiki/Kotlin-Coroutines)
* [DataProvider & LiveData](https://github.com/oppia/oppia-android/wiki/DataProvider-&-LiveData)
Expand Down