Skip to content

Establish a process and describe it in the readme #1

@soupi

Description

@soupi

A potential contributor who is interested in contributing to the project would probably like to be able to quickly understand the spirit and state of the project and how they can contribute to it.

We should establish the following things, and for them to be written in or linked from the readme:

What is the vision/ethos of the performance tuning book?

Establish what kind of resource perf-book is, what are the guiding principles and who is the target audience. It should also help answering questions such as:

  • Which topics should be covered and which shouldn't (e.g. laziness/strictness, STG machine, reading core, algorithms complexity, rewrite rules, etc.)
  • What style should chapters look like? (reference, prose, concise, have many examples, etc.)
  • Is this guide right for me?

Roadmap

Which content is planned for perf-book? What is the status of each task? What is the priority of tasks (if there is one)? Can I suggest new topics?

Let's create some sort of a table or a board of the currently planned chapters and give each chapter a status which could be one of these:

  • Waiting for a contributor
  • Assigned to a contributor
  • PR in progress
  • PR pending review
  • Completed

How to contribute

Here are a bunch of questions a potential contributor may ask:

  • Can I contribute a chapter?
  • Can I review PRs?
  • What is the process of contributing? How is new content released and when?
  • How do I volunteer?
  • What is expected of me? (stellar english? Haskell Expert™? finish work in a week? Answer reviewers in minutes?)
  • How will I know if my work is good?
  • Will I get help?
  • What are the guidelines for this project?
  • License of the project and my contribution?
  • Is there anything I need to know? (style guide, tech, etc.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions