Skip to content

Commit

Permalink
Update docs to remove oppia-android-dev@ list (which is deprecated) a…
Browse files Browse the repository at this point in the history
…nd mentions of individual mentors (we now handle queries on GitHub Discussions). (#5605)

<!-- READ ME FIRST: Please fill in the explanation section below and
check off every point from the Essential Checklist! -->

## Explanation

Removes the deprecated oppia-android-dev@ list and directs contributors
to GitHub Discussions. Also cleans up mentions of individual mentor
assignment since we now use Discussions for handling queries.

## Essential Checklist
- [ ] 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: ...".) -- N/A
- [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)).

Co-authored-by: Ben Henning <[email protected]>
  • Loading branch information
seanlip and BenHenning authored Dec 27, 2024
1 parent f4c7e6e commit 6fb97ba
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [Oppia Android](https://www.oppia.org)

[![Mailing List](https://img.shields.io/badge/Mailing%20List-Oppia%20Android-dev.svg)](mailto:[email protected]) [![Twitter Follow](https://img.shields.io/twitter/follow/oppiaorg.svg?style=social&label=Follow&maxAge=2592000?style=flat-square)](https://twitter.com/oppiaorg) [![GitHub issues by-label](https://img.shields.io/github/issues-search/oppia/oppia-android?label=Available%20starter%20issues&query=is%3Aopen%20is%3Aissue%20label%3A%22good%20first%20issue%22%20no%3Aassignee)](https://github.com/oppia/oppia-android/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+no%3Aassignee)
[![Twitter Follow](https://img.shields.io/twitter/follow/oppiaorg.svg?style=social&label=Follow&maxAge=2592000?style=flat-square)](https://twitter.com/oppiaorg) [![GitHub issues by-label](https://img.shields.io/github/issues-search/oppia/oppia-android?label=Available%20starter%20issues&query=is%3Aopen%20is%3Aissue%20label%3A%22good%20first%20issue%22%20no%3Aassignee)](https://github.com/oppia/oppia-android/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+no%3Aassignee)

[![Unit Tests (Robolectric -- Gradle)](https://github.com/oppia/oppia-android/actions/workflows/main.yml/badge.svg)](https://github.com/oppia/oppia-android/actions/workflows/main.yml) [![Unit Tests (Robolectric - Bazel)](https://github.com/oppia/oppia-android/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/oppia/oppia-android/actions/workflows/unit_tests.yml) [![Build Tests](https://github.com/oppia/oppia-android/actions/workflows/build_tests.yml/badge.svg)](https://github.com/oppia/oppia-android/actions/workflows/build_tests.yml) [![Static Checks](https://github.com/oppia/oppia-android/actions/workflows/static_checks.yml/badge.svg)](https://github.com/oppia/oppia-android/actions/workflows/static_checks.yml)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ package org.oppia.android.testing.threading
* Robolectric-specific API methods (e.g. [runCurrent], [advanceTimeBy], and [advanceUntilIdle]).
*
* *NOTE TO DEVELOPERS*: This class is NOT yet ready for broad use in Espresso until after #89 is
* fully resolved. Please ask in oppia-android-dev if you have a use case that you think requires
* fully resolved. Please ask on GitHub Discussions if you have a use case that you think requires
* this class. Specific cases will be allowed to integrate with if other options are infeasible.
* Other tests should rely on existing mechanisms until this utility is ready for broad use. All
* Robolectric tests should use this class instead of manually creating their own test dispatchers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ import javax.inject.Singleton
* as expected.
*
* Many of these tests also depend on real time, which means different performing machines may
* introduce flakes when running these tests. Please reach out to [email protected]
* if you find yourself in this situation.
* introduce flakes when running these tests. Please reach out on GitHub Discussions if you find
* yourself in this situation.
*
* For developers changing this suite: note that an n-threaded real dispatcher is used to test
* blocking operations since coordinating multiple co-dependent test dispatchers creates a circular
Expand Down
4 changes: 1 addition & 3 deletions wiki/Contributing-to-Oppia-Android.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ When you've found an issue you'd like to tackle:

- Leave a comment that describes in detail how you'll tackle it (e.g. explain which file(s) you would modify and what changes you would make), and @-mention the team lead (typically **@BenHenning**). If your explanation makes sense, we'll assign the issue to you.
- Submit a PR, following the [guidance on submitting a PR](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR). (Consider bookmarking this guide in your browser for easy reference. We also suggest bookmarking the ["my issues" page](https://github.com/issues/assigned) so that you can keep track of the issues assigned to you.)
- If you run into any problems, feel free to create a [GitHub Discussion](https://github.com/oppia/oppia-android/discussions) and get help from the Oppia community, or [request a mentor](https://forms.gle/udsRP4WQgLcez9Zm8) if you'd like individual support.
- If you run into any problems, feel free to create a [GitHub Discussion](https://github.com/oppia/oppia-android/discussions) and get help from the Oppia community.

You are also welcome to tackle non-starter issues, but for those, you might need to be more independent, because we might not know how to solve them either!

Expand Down Expand Up @@ -106,5 +106,3 @@ For now, you generally won't need to do this, until the Android app supports on-
## Communication channels

If you run into any problems (including non-coding ones), you can ask questions on [GitHub Discussions](https://github.com/oppia/oppia-android/discussions). You can use this avenue for asking anything -- questions about any issue, who to contact for specific things, etc.

You can also check out the [developer mailing list](https://groups.google.com/forum/?fromgroups#!forum/oppia-android-dev).
6 changes: 3 additions & 3 deletions wiki/Debugging-Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Whenever you are debugging a problem, you may find it useful to keep a record of
- [1. Begin with Describing What Goes Wrong](#1-begin-with-describing-what-goes-wrong)
- [2. Describe Your Investigations](#2-describe-your-investigations)
- [3. Document Your Guesses and Testing](#3-document-your-guesses-and-testing)
- [4. Continue/Review from Mentor](#4-continuereview-from-mentor)
- [4. Continue/Share on GitHub Discussions](#4-continueshare-on-github-discussions)
- [5. Document Your Solution](#5-document-your-solution)
- [Get Started](#get-started)

Expand Down Expand Up @@ -37,9 +37,9 @@ What did you try, and what happened when you tried it? You want to include enoug

After some investigation, you might have some ideas for what might be going wrong. Document your guesses and describe how you go about testing them. Report the results of that testing and describe whether you think your guess was right. What's your reasoning?

### 4. Continue/Review from Mentor
### 4. Continue/Share on GitHub Discussions

Keep going! Continue documenting your investigations, guesses, and tests of those guesses. You can share your debugging doc with your assigned onboarding mentor to review and help you in finding the root cause of the issue or the solution.
Keep going! Continue documenting your investigations, guesses, and tests of those guesses. You can share your debugging doc on GitHub Discussions to review and help you in finding the root cause of the issue or the solution.

### 5. Document Your Solution

Expand Down
4 changes: 2 additions & 2 deletions wiki/Firebase-Console-Guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This document is made as a guide for viewing and customising the Firebase project(s) of Oppia-Android. It is recommended to fully read this doc before making any changes to the Firebase project. If you only want to view the Firebase console then this doc can help you in viewing exactly the thing that you want to see. It must also be noted that appropriate permissions are required for viewing/editing anything in the console. For permissions, please contact [email protected].
This document is made as a guide for viewing and customising the Firebase project(s) of Oppia-Android. It is recommended to fully read this doc before making any changes to the Firebase project. If you only want to view the Firebase console then this doc can help you in viewing exactly the thing that you want to see. It must also be noted that appropriate permissions are required for viewing/editing anything in the console. For permissions, please ask in the Android team group chat.

## Table of Contents
* [Viewing the Console](#viewing-the-console)
Expand Down Expand Up @@ -111,4 +111,4 @@ You can enable verbose logging with a series of adb commands:
* `adb shell setprop log.tag.FA-SVC VERBOSE`
* `adb logcat -v time -s FA FA-SVC`

This command displays your events in the Android Studio logcat, helping you immediately verify that events are being sent.
This command displays your events in the Android Studio logcat, helping you immediately verify that events are being sent.
29 changes: 13 additions & 16 deletions wiki/Get-Help.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Table of Contents

* [Communication channels](#communication-channels)
* [Email](#email)
* [GitHub Discussions](#github-discussions)
* [Google Chat or Hangouts](#google-chat-or-hangouts)
* [GitHub](#github)
* [Google Chat](#google-chat)
* [Email](#email)
* [How to Ask Good Questions](#how-to-ask-good-questions)
* [Setup-related questions](#setup-related-questions)
* [Before you ask a setup question](#before-you-ask-a-setup-question)
Expand All @@ -20,15 +20,6 @@ Here we document Oppia's main communication channels and how to ask good questio

If you need help, there are a few communication channels you can use. Developers usually respond within 24 hours so long as you use a channel they actually check.

### Email

We have several mailing lists in the form of Google Groups that you can join:

* [oppia-announce](https://groups.google.com/forum/#!forum/oppia-announce) is for announcements of new releases or blog posts. It's not for asking questions though.
* [oppia-android-dev](https://groups.google.com/g/oppia-android-dev) is the main mailing list for communication between developers and for technical questions. You can post to it even if you're not a member of the group. This is where you can ask questions, solicit feedback, or make developer-specific announcements (e.g. a temporary GitHub outage).

You can also email your mentor with any questions. If you don't have a mentor, complete the steps on the [wiki page for contributing code to Oppia](https://github.com/oppia/oppia-android/wiki/Contributing-to-Oppia-android) and you'll be assigned one.

### GitHub Discussions

If you have questions regarding Oppia Android, you can create a discussion on [GitHub Discussions](https://github.com/oppia/oppia-android/discussions/) where other developers will assist you in resolving the issue. Oppia's Welfare team monitors this chat to help out new contributors, so it's the best place to ask questions about Oppia or getting started. You can create a discussion in any of the following categories based on the question:
Expand All @@ -39,16 +30,22 @@ If you have questions regarding Oppia Android, you can create a discussion on [G

Feel free to drop in and [say hi](https://github.com/oppia/oppia-android/discussions/4788)! You can also refer to [this guide](https://docs.github.com/en/discussions/quickstart#creating-a-new-discussion) on how to create a new discussion.

### Google Chat or Hangouts
### Google Chat

Most Oppia developers and teams use Google Chat as their primary means of communication, and they usually respond quickly. However, invites often get lost in spam folders, and some developers use a non-public email address for Google Chat. You can ask your mentor to put you in touch with a developer if you don't know their address or if they haven't acted on your invite.
Most Oppia developers and teams use Google Chat as their primary means of communication, and they usually respond quickly. However, invites often get lost in spam folders, and some developers use a non-public email address for Google Chat. You can ask in GitHub Discussions if you need to get in touch with a particular developer.

### GitHub

If you have a question about a pull request or issue, you can also reach out to developers by at-mentioning them (e.g. `@developer-username`) in a comment and assigning them to the issue. Be sure you both at-mention and assign them! Some developers only look at their GitHub notifications (which at-mentions trigger), while others only look at what they're assigned to.

You can even mention whole teams of people! For example, if you find an issue that is destabilizing the project, you could notify all the core maintainers by including `@oppia/core-maintainers` in your issue. The teams are all listed [here](https://github.com/orgs/oppia/teams).

### Email

We have an announcement mailing list in the form of Google Groups that you can join:

* [oppia-announce](https://groups.google.com/forum/#!forum/oppia-announce) is for announcements of new releases or blog posts. It's not for asking questions though.

## How to Ask Good Questions

At Oppia we don’t care how silly your question is! Just ensure your question is clear, and provide us with enough information to help us resolve it faster. We've divided the questions into 2 categories - Setup-related and General questions. You can start following the sections below to understand how you can ask each of them.
Expand Down Expand Up @@ -109,7 +106,7 @@ paste a screenshot
Follow the template below for asking questions (fill in the values inside {{}} brackets and mark x inside checkboxes to tick them) to leave a comment on a pull request. Adapt the template as needed if you are using another channel.

```md
@{{PR reviewer or Mentor username}} PTAL!
@{{PR reviewer}} PTAL!

**Checklist**
- [ ] I have filled the [CLA](https://goo.gl/forms/AttNH80OV0) and the [Oppia Contributor Survey](https://goo.gl/forms/otv30JV3Ihv0dT3C3)
Expand All @@ -136,7 +133,7 @@ Follow the template below for asking questions (fill in the values inside {{}} b

* If you are unable to push changes due to some reason, you can create a [patch file](https://docs.gitlab.com/omnibus/development/creating-patches.html) and share it with the person you're asking for help.

* If you are facing issues in completing the assigned task, you can create a PR on your fork of the oppia-android repository, troubleshoot your problem on that pull request with help from your mentor, and then create a new PR on the original oppia-android repository.
* If you are facing issues in completing the assigned task, you can create a PR on your fork of the oppia-android repository, troubleshoot your problem on that pull request, and then create a new PR on the original oppia-android repository.

* If you have not made a PR yet, because you are not sure:

Expand All @@ -148,7 +145,7 @@ Follow the template below for asking questions (fill in the values inside {{}} b

* If you want to have a discussion on your approach, but aren’t ready to make a PR yet, you can create a [public gist](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) and include the link to it in your question. It’s always better to see the code you are talking about!

* **Avoid asking for help from people via emails or direct messaging.** We encourage everyone to ask for help on a common channel so that whoever sees your query first can help you or guide you how to take your query forward. Note that directing questions to your mentor is fine.
* **Avoid asking for help from people via emails or direct messaging.** We encourage everyone to ask for help on a common channel like GitHub Discussions so that whoever sees your query first can help you or guide you how to take your query forward.

* Comment on the issue page or the PR if your question is very specific.

Expand Down
2 changes: 1 addition & 1 deletion wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ To make it easier to get started, we've catalogued some different ways to help o

If you are interested in working on Oppia's web repository, you should also look at the [oppia/oppia repository](https://github.com/oppia/oppia).

If you run into any problems, you can ask questions on [GitHub Discussions](https://github.com/oppia/oppia-android/discussions). You can also check out the [developer mailing list](https://groups.google.com/forum/?fromgroups#!forum/oppia-android-dev).
If you run into any problems, you can ask questions on [GitHub Discussions](https://github.com/oppia/oppia-android/discussions).

Finally, if, after reading the above links, you'd like to help but aren't sure how -- don't worry! The Oppia project is very multi-faceted, and we'd be glad to help you find something to do that matches your interests and skills. Just fill out [this form](https://forms.gle/jEytndtgdsx7BrnV6) to let us know what you'd like to help with, or write to us at [[email protected]](mailto:[email protected]) and tell us a bit about yourself and what you'd like to do. We'll do our best to help you get started!

0 comments on commit 6fb97ba

Please sign in to comment.