You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
These READMEs have the function of both introducing contributors to the project's mission and aims, and helping them get started.
The READMEs, so far, have been put together piecemeal. The aim of this issue is to apply a UX Writing approach to them so that the introductions to the repositories are compelling and clearly help prospective developers understand the project and get started easily.
UXR success criteria
Developers understand and are inspired by the Oppia project's mission, vision and impact. (We might want to highlight some pictures of areas we work in or organizations we partner with -- it might be worth getting some information from the Programs team about anything we can say that is going to be true over the long term.)
Developers can easily find where to get started (https://github.com/oppia/oppia/wiki for Oppia Web, https://github.com/oppia/oppia-android/wiki for Oppia Android). Note: Those two pages have not been edited in a long time, and we might want to include them in the UX Writing pass so that the "new contributor" experience flows smoothly. Developers should get routed to the developer "getting started" instructions, and other volunteers should get routed to the Volunteer page or Volunteer form (whichever is appropriate).
The README doesn't end up being a roadblock for developers (e.g. too much to read).
DESIGN APPROVAL CHECKLIST -- DO NOT EDIT.
UX Design approved (Android mocks should include dark mode)
UX Writing approved
Product approved
For a design project to be completed, it needs approval from UXD, UXW and PM. Please tag the following reviewers when your project is ready (at least one reviewer for each of the bullet points below):
Platform
GitHub
Describe the request
We have several developer-facing GitHub projects, all of which have READMEs:
These READMEs have the function of both introducing contributors to the project's mission and aims, and helping them get started.
The READMEs, so far, have been put together piecemeal. The aim of this issue is to apply a UX Writing approach to them so that the introductions to the repositories are compelling and clearly help prospective developers understand the project and get started easily.
UXR success criteria
DESIGN APPROVAL CHECKLIST -- DO NOT EDIT.
For a design project to be completed, it needs approval from UXD, UXW and PM. Please tag the following reviewers when your project is ready (at least one reviewer for each of the bullet points below):
The text was updated successfully, but these errors were encountered: