From f7d23ee38bd7e80c62cbd06d7633232f45d0e52b Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Tue, 14 Nov 2017 21:30:41 -0800 Subject: [PATCH] docs: Make minor updates to CONTRIBUTING.md and README.md. --- CONTRIBUTING.md | 11 ++++++----- README.md | 9 +++++---- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 031d364f2f..f70bb0f920 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,7 +106,7 @@ on. important thing to say is whether you're looking for a backend (Python), frontend (JavaScript), mobile (React Native), desktop (Electron), documentation (English) or visual design (JavaScript + CSS) issue, and a - bit about your programming experience. + bit about your programming experience and available time. We also welcome suggestions of features that you feel would be valuable or changes that you feel would make Zulip a better open source project. If you @@ -117,7 +117,7 @@ feature idea and the problem that you're hoping to solve. Other notes: * For a first pull request, it's better to aim for a smaller contribution than a bigger one. Many first contributions have fewer than 10 lines of - changes (not counting tests). + changes (not counting changes to tests). * The full list of issues looking for a contributor can be found with the [help wanted](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label. @@ -154,8 +154,9 @@ labels. ## What makes a great Zulip contributor? -Zulip runs a lot of internship programs, so we have a lot of experience with -new contributors. In our experience, these are the best predictors of success: +Zulip runs a lot of [internship programs](#internship-programs), so we have +a lot of experience with new contributors. In our experience, these are the +best predictors of success: * Posting good questions. This generally means explaining your current understanding, saying what you've done or tried so far, and including @@ -227,7 +228,7 @@ Zulip runs internship programs with [Outreachy](https://www.outreachy.org/), [Google Summer of Code](https://developers.google.com/open-source/gsoc/), and the [MIT Externship program](https://alum.mit.edu/students/NetworkwithAlumni/ExternshipProgram), -and also takes summer interns from Harvard, MIT, and Stanford. +and has in the past taken summer interns from Harvard, MIT, and Stanford. The application process and selection criteria for all our internship programs is the same. A few notes: diff --git a/README.md b/README.md index 4f369af6dd..e5b2892980 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,14 @@ largest and fastest growing open source group chat project. [![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org) [![Twitter](https://img.shields.io/badge/twitter-@zulip-blue.svg?style=flat)](http://twitter.com/zulip) -## Next steps +## Getting started Click on the appropriate link below. If nothing seems to apply, join us on the [Zulip community server](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html) and tell us what's up! -I am interested in: +You might be interested in: * **Contributing code**. Check out our [guide for new contributors](https://zulip.readthedocs.io/en/latest/contributing.html) @@ -66,8 +66,9 @@ I am interested in: [Outreachy](https://www.outreachy.org/), [Google Summer of Code](https://developers.google.com/open-source/gsoc/), and the - [MIT Externship program](https://alum.mit.edu/students/NetworkwithAlumni/ExternshipProgram), - and also takes summer interns from Harvard, MIT, and Stanford. More + [MIT Externship program](https://alum.mit.edu/students/NetworkwithAlumni/ExternshipProgram). Zulip + also participates in + [Google Code-In](https://developers.google.com/open-source/gci/). More information is available [here](https://zulip.readthedocs.io/en/latest/contributing.html#internship-programs).