Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Establish a process and describe it in the readme #1

Open
soupi opened this issue Jul 12, 2021 · 1 comment
Open

Establish a process and describe it in the readme #1

soupi opened this issue Jul 12, 2021 · 1 comment

Comments

@soupi
Copy link

soupi commented Jul 12, 2021

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.)
@soupi soupi changed the title Establish a process and describe it in the README Establish a process and describe it in the readme Jul 12, 2021
@soupi
Copy link
Author

soupi commented Jul 19, 2021

I added a readme, a contributing guide, and a license (CC-BY-4.0) in a different repository and I would appreciate some more eyes on it before I push it to this repo!
CC @emilypi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant