Skip to content

Latest commit

 

History

History
41 lines (39 loc) · 3.25 KB

annual-survey.md

File metadata and controls

41 lines (39 loc) · 3.25 KB

Rust annual survey guide

This document describes a brief guide on how to prepare the yearly Rust annual survey. It is probably not complete, but it should nevertheless be helpful as a guide.

  1. Copy survey from last year and perform basic modifications
    • Create surveys/<year>-annual-survey/questions.md and copy questions from the last year into it
    • Change basic time information, e.g. bump years
    • Change Rust versions (usually they move forward by ~10 versions, based on the 6-week schedule)
    • See #234 for an example PR
  2. Go through the issue tracker and try to resolve issues from the last year
    • Try to find issues that could be applicable, and modify the questions accordingly via PRs to this repo
  3. Ask for general feedback for question/answer additions/modifications
    • Ideally, ask in the #rust-survey or #general Zulip streams, and also try to ask the individual top level teams (t-compiler, t-lang, t-cargo etc.).
  4. Finalize the questions/answers for the given year (ideally by end of September)
  5. Put the survey questions to SurveyHero
    • This needs collaboration with the Rust foundation, please ask in the #rust-survey Zulip stream for assistance.
  6. Translate the questionnaire
    • SurveyHero can generate the questionnaire in other languages, uses some machine translation which often leaves a bit to desire
    • Find translators for reviewing the survey and the auto-generated translations
    • You can ask around on the #rust-survey or #general Zulip streams for assistance.
    • Be aware that the SurveyHero export feature is currently broken (breaks non Latin alphabets) and importing the translations is not allowed. Correcting the translations is therefore a manual work both for the translator and for the operator that has access to the SurveyHero backoffice.
    • Translators can take advantage of this small guide
  7. Double-check the survey flow in SurveyHero
    • Go through all the possible paths through the survey, and check that the questions and answers in SurveyHero are the same as in questions.md.
    • Possible problems:
      • Missing answers or questions
      • Wrong survey flow (questions being skipped, or not being skipped, when they should be)
      • Radio buttons instead of checkboxes for exclusive answers
      • Typos
    • Optionally, the verifier binary can also be used to check this, if you are able to get access to the SurveyHero API for the survey.
  8. Prepare a PR to https://blog.rust-lang.org/ with a blog post notifying about the survey
    • See this PR for an example
    • Make sure to communicate the deadline of the survey, and include the survey link multiple times in the blog post!

After the survey finishes

See this issue.