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 #27

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

Establish a process and describe it in the README #27

soupi opened this issue Jul 6, 2021 · 1 comment

Comments

@soupi
Copy link

soupi commented Jul 6, 2021

As a potential contributor who is interested in contributing to the project, I would like to be able to quickly understand the spirit and state of the project and how can I contribute to it.

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

What is the vision/ethos of Haskell School?

Establish what kind of resource Haskell School 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. lambda calculus, template haskell, f-algebras, parsing, arrows, lenses, nix, etc.)
  • What style should Haskell School tutorials look like? (reference, prose, concise, have many examples, etc.)
  • Is this guide right for me?

Roadmap

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

I would suggest creating 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 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.)
@ulysses4ever
Copy link
Contributor

Very good!

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

I'd add:

  • How/when do I contribute a translation of a chapter

A possible answer may be: lookup a corresponding issue or create one first.

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

2 participants