From 9b64f6c6b8e35394371596cdd6f393603b2b5dc5 Mon Sep 17 00:00:00 2001 From: Xinyu Wu Date: Mon, 12 Sep 2016 17:54:58 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dec102b29c15..5537f0b3b15b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,9 @@ We have also recently started offering office hours for new contributors on Gitt If you have an idea for something to do, first check if it's already on the [issue tracker](https://github.com/oppia/oppia/issues). If so, add a comment to the issue saying you'd like to work on it, and we'll help you get started! Otherwise, please file a new issue, and say you'd like to work on it. -If you don't have an idea for something to do, try searching the issue tracker for something that looks interesting! High-priority issues are tracked by [milestones](https://github.com/oppia/oppia/milestones), so we recommend starting there, but feel free to take on any of the others as well. Each issue is tagged based on which part of the site it affects, and also categorized based on the type of help needed. If this is your first contribution, we recommend picking one of the following types of issues: +To get acquainted with the codebase and the contribution workflow, a good place to start is by documenting code. A list of files which need documentation is [here](https://github.com/oppia/oppia/issues/2394). + +You can also try searching the issue tracker for something that looks interesting. High-priority issues are tracked by [milestones](https://github.com/oppia/oppia/milestones), so we recommend starting there, but feel free to take on any of the others as well. Each issue is tagged based on which part of the site it affects, and also categorized based on the type of help needed. If this is your first code contribution, we recommend picking one of the following types of issues: * **[TODO: code](https://github.com/oppia/oppia/labels/TODO%3A%20code)** means that the issue is suitable for new developers: the overall solution is known and is described in the issue, and the only thing left to do is code it. * **[TODO: design (UI/Interaction)](https://github.com/oppia/oppia/labels/TODO%3A%20design%20%28UI%2Finteraction%29)** means that the issue is suitable for new UI designers, interaction designers, artists and writers. In general, it means that UI design help is needed, and the deliverable would usually be a mockup, drawing, prototype or text that conveys what the feature should look like. @@ -33,6 +35,8 @@ If you don't have an idea for something to do, try searching the issue tracker f These issues, also tagged as 'starter projects', are usually local to a small part of the codebase. They tend to be easier, so they give you a chance to get your feet wet without having to understand the entire codebase. If you'd like some help finding an issue to work on, please don't hesitate to reach out to us at the [developers' mailing list](https://groups.google.com/forum/#!forum/oppia-dev) or the [Gitter chat room](https://gitter.im/oppia/oppia-chat)! Also, if the issue you're working on has a grey label of the form "team-name (@team-lead)", please feel free to reach out to that team lead for help or advice on that issue -- they should be able to answer questions about that area of the codebase. +After working on one or two starter projects, you should look at the projects in the [milestores](https://github.com/oppia/oppia/milestones), which are high-priority projects which we are focusing on right now. You can also ask for suggestions on issues to work on next on [Gitter](https://gitter.im/oppia/oppia-chat), and we can help you find a good project, based on your interests and past contributions. + For reference, here are descriptions of what the other 'TODO' tags mean: * **[TODO: tech (instructions)](https://github.com/oppia/oppia/labels/TODO%3A%20tech%20%28instructions%29)** means that the overall solution is generally known, but newcomers to the codebase may need additional instructions to be able to implement them. Adding instructions, such as where to make the necessary changes, will help move these issues to the `TODO: code` stage. * **[TODO: tech (breakdown)](https://github.com/oppia/oppia/labels/TODO%3A%20tech%20%28breakdown%29)** means that the approach is known, but needs to be broken down into single-person projects.