Skip to content
Open
No due date
Last updated Feb 22, 2023
4% complete

Phase 0: Initialization

This is an initialization phase, its purpose is to get the project up and
running and ready for external contributions. Note that the last item of each
phases' checklist is a community check-in. Phase0 is completed when:

  • : Working repository for the book is setup.
  • : Continuous integration for the book is setup and the book builds for
    every commit to main.
  • : Github project is setup.
  • : Contribution guide for sections in Part 1 is complete.
  • : Contribution guide for sections in Part 2 is complete.
  • : Part 1 section checklist is complete.
  • : Part 2 section checklist is complete.
  • : Case study checklist is complete.
  • : Three sections of Part 1 (Measurement) are complete.
  • : Three section of Part 2 (Optimizations) are complete.
  • : One case study is complete.
  • : List of contributors is initialized.
  • : Community check in has been done on Discourse.Haskell after each other
    bullet is complete

The deliverables for this phase constitute examples for other contributors, so
that when and if an external contributor tries to contribute they have something
to work off of rather than a blank page. In particular they have checklists to
work off of and example sections to refer to. This lowers the barrier of entry
for new contributors and creates a positive reinforcement loop as the book
progresses. An example checklist for an external tooling section could be:

- [ ] provide the motivation for using the external tool
- [ ] provide a phrase "use this tool when ..."
- [ ] provide the expected output of the tool "With this tool you can retrieve this important information"
- [ ] provide the platforms that support this tool, if a platform does not
  please state either: 1) an alternate tool to retrieve the same information or 2) a statement that this tool is not supported on the platform
- [ ] if you read the first line of each paragraph, they are form a coherent story
  , and that story arrives at the point of the section, within reason.
- [ ] The section has a closing summary that repeats: when to use the tool, what information can be retreived with the tool, which performance issues this tool helps with, and how to run/use the tool.
- [ ] After the summary there is a summary of command line invocations and their corresponding meaning
- [ ] The section has a reference subsection
- [ ] The book builds with the PR (this should be CI)

List view

  • Status: Open.
    #3 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 24, 2022
  • Status: Open.
    #4 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 24, 2022
  • Status: Open.
    #5 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 24, 2022
  • Status: Open.
    #6 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 24, 2022
  • Status: Open.
    #7 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 24, 2022
  • Status: Open.
    #8 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 24, 2022
  • Status: Open.
    #9 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 26, 2022
  • Status: Open.
    #10 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 26, 2022
  • Status: Open.
    #11 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 26, 2022
  • Status: Open.
    #12 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 26, 2022
  • Status: Open.
    #13 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 26, 2022
  • Status: Open.
    #14 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on May 26, 2022
  • Status: Open.
    #17 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Jun 23, 2022
  • Status: Open.
    #18 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Jun 27, 2022
  • Status: Open.
    #22 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 17, 2022
  • Status: Open.
    #23 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 17, 2022
  • Status: Open.
    #30 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 19, 2022
  • Status: Open.
    #39 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 23, 2022
  • Status: Open.
    #40 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 23, 2022
  • Status: Open.
    #41 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 23, 2022
  • Status: Open.
    #42 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 23, 2022
  • Status: Open.
    #43 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 23, 2022
  • Status: Open.
    #45 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 23, 2022
  • Status: Open.
    #57 In haskellfoundation/hs-opt-handbook.github.io;
    · doyougnu opened on Aug 31, 2022