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

docs: Add links to new contributor docs to overall guide.

This commit is contained in:
Alya Abbott 2022-09-20 09:43:55 -07:00 committed by Tim Abbott
parent 6e2f781cf7
commit e03afc2b3c
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -344,13 +344,11 @@ labels.
Zulip has a lot of experience working with new contributors. In our Zulip has a lot of experience working with new contributors. In our
experience, these are the best predictors of success: experience, these are the best predictors of success:
- Posting good questions. It's very hard to answer a general question like, "How - [Asking great questions][great-questions]. It's very hard to answer a general
do I do this issue?" When asking for help, explain question like, "How do I do this issue?" When asking for help, explain your
your current understanding, including what you've done or tried so far and where current understanding, including what you've done or tried so far and where
you got stuck. Post tracebacks or other error messages if appropriate. For you got stuck. Post tracebacks or other error messages if appropriate. For
more information, check out the ["Getting help" section of our community more advice, check out [our guide][great-questions]!
guidelines](https://zulip.com/development-community/#getting-help) and
[this essay][good-questions-blog] for some good advice.
- Learning and practicing - Learning and practicing
[Git commit discipline](https://zulip.readthedocs.io/en/latest/contributing/version-control.html#commit-discipline). [Git commit discipline](https://zulip.readthedocs.io/en/latest/contributing/version-control.html#commit-discipline).
- Submitting carefully tested code. See our [detailed guide on how to review - Submitting carefully tested code. See our [detailed guide on how to review
@ -359,6 +357,8 @@ experience, these are the best predictors of success:
- Posting - Posting
[screenshots or GIFs](https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html) [screenshots or GIFs](https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html)
for frontend changes. for frontend changes.
- Working to [make your pull requests easy to
review](https://zulip.readthedocs.io/en/latest/contributing/reviewable-prs.html).
- Clearly describing what you have implemented and why. For example, if your - Clearly describing what you have implemented and why. For example, if your
implementation differs from the issue description in some way or is a partial implementation differs from the issue description in some way or is a partial
step towards the requirements described in the issue, be sure to call step towards the requirements described in the issue, be sure to call
@ -369,10 +369,7 @@ experience, these are the best predictors of success:
- Being helpful and friendly on the [Zulip community - Being helpful and friendly on the [Zulip community
server](https://zulip.com/development-community/). server](https://zulip.com/development-community/).
[good-questions-blog]: https://jvns.ca/blog/good-questions/ [great-questions]: https://zulip.readthedocs.io/en/latest/contributing/asking-great-questions.html
These are also the main criteria we use to select candidates for all
of our outreach programs.
## Reporting issues ## Reporting issues