Contributing to Zulip

• Contributing guide
  • Zulip development community
  • Ways to contribute
  • Your first codebase contribution
    • Where to look for an issue
    • Picking an issue to work on
    • Claiming an issue
    • Working on an issue
    • Submitting a pull request
    • Stages of a pull request
    • Beyond the first issue
    • Common questions
  • What makes a great Zulip contributor?
  • Reporting issues
  • User feedback
  • Outreach programs
  • Stay connected
  • Help others find Zulip
• Zulip Code of Conduct
  • Expected behavior
  • Unacceptable behavior
  • Reporting and enforcement
  • Scope
  • License and attribution
• Asking great questions
  • Where to ask your question
  • How to ask a great question
  • Follow the community guidelines
• Design discussions
  • Guidelines for all participants
  • Participant roles
  • Guidelines for code contributors
    • When to post
    • Guidelines for requesting design feedback
  • Guidelines for community moderators
    • Improving the quality of discussions
    • Moving threads to the most appropriate stream
  • Guidelines for decision makers
    • Managing the discussion
    • From discussion to decision
• Version control
  • Commit discipline
  • Commit messages
    • Good summaries:
    • Message body:
• Code style and conventions
  • Be consistent!
  • Lint tools
  • Secrets
  • Dangerous constructs
    • Too many database queries
    • UserProfile.objects.get() / Client.objects.get() / etc.
    • Using Django model objects as keys in sets/dicts
    • user_profile.save()
    • Using raw saves to update important model objects
    • Naive datetime objects
    • x.attr('zid') vs. rows.id(x)
    • JavaScript const and let
    • JavaScript and TypeScript for (i in myArray)
    • Translation tags
    • Paths to state or log files
  • JS array/object manipulation
  • More arbitrary style things
    • Line length
    • JavaScript and TypeScript
    • HTML / CSS
    • Python
    • Tests
    • Third party code
• Reviewable pull requests
  • Posting a pull request
  • Addressing feedback
  • Working on larger projects
• Reviewing Zulip code
  • Principles of code review
    • Reviewing your own code
    • Reviewing other contributors’ code
  • How to review code
    • Code review checklist
    • Automated testing
    • Manual testing
  • Review process and communication
    • Asking for a code review
    • Reviewing someone else’s code
    • Responding to review feedback
  • Additional resources
• Using zulipbot
  • Usage
    • Contributing
• Bug report guidelines
• Licensing
  • Contributing your own work
  • Contributing someone else’s work