Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Make minor updates to CONTRIBUTING.md and README.md.

This commit is contained in:
Rishi Gupta 2017-11-14 21:30:41 -08:00 committed by Tim Abbott
parent 744c4af958
commit f7d23ee38b
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -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:

9
README.md
View File

@ -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).