Code Monkey home page Code Monkey logo

writers-workshop's Introduction

quansight writers workshop

the quansight writers workshop is a creative program focused on learning how to write literate programs. we will learn to strive for literary excellence in all of our works like blogs, white papers, code, and documentation. we'll supplement language and design with code to acheive interesting, eccentric stories.

the cirriculum is designed for all open source participants, one can get by mostly on markdown language alone. we explore writing for ourselves, others, and, the hardest of all, ourselves.

grading

we have a hippy grade system where you grade yourselves. the classes worked will be collected into a single document that represents the groups collective works. you will be able to measure yourselves collectively, and be wildly impressed with the outcomes.

syllabus

week 1 - the hardest class of all

writing about you! in this class we talk about the value of the readme file in general. it is a canonical piece of coding literature at this point, eat me, drink me.

homework - create your readme repository

week 2 - reading and writing literature with code

scientists, developers, and designers write in code STOP

there are few best practices when language and code collide, but there are style choices. this class is about exploring styles of writing that work for you.

homework

write a short story involving some language and some code in markdown, rst or notebooks.

week 3 - peer review

the outcome of this class is about our collective efforts. when we write together, we read together, and publish together. it is important to provide actionable feedback to works that you share attribution with.

homework

in this weeks homework we think about issues as literature. i want you all to pair up in groups and review each others works.

how publishing works

we aren't saying everything passes, we have standards!

  1. 🥚 the issue is triaged by an editor within the first 24 business hours
  2. 📛 issue is tagged
  3. 🧐 reviewers manual assigned
  • ⏲️ countdown begins 7️⃣5️⃣3️⃣1️⃣
    • ❓ reviewers assign themselves
    • 🤔 review required
    • ♻️ restart countdown
  • 🏁 no review required after 7️⃣5️⃣3️⃣1️⃣ days
  • 🏆 close and accept
  1. 🟢 tests pass
  2. 🌝 there are sufficient reviews, or reactions

writers-workshop's People

Contributors

tonyfast avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.