Skip to content

Add CONTRIBUTING.org and .editorconfig #31

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
root = true

[*.org]
max_line_length = 66
47 changes: 47 additions & 0 deletions CONTRIBUTING.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
* Contributing

Thank you for your interest! A lot of help is needed to finish
this some day.

** What remains to be done

The most important task is to finish fixing the text and examples
marked as ~TODO~ in the [[file:README.org][README]]. The files
marked ~DONE~ where tested with GHC 8.4 and should be updated at
some point to whatever is the latest version of the compiler so
feel free to do that. Please update the [[file:README.org][README]]
once all the examples in a file run in the current GHC version.

Please have a look at the [[https://github.com/tssm/up-to-date-real-world-haskell/tree/wip-monad-transformers][wip-monad-transformers]]
branch if you don't know where to start.

A long term goal is to extract the code from the Org files and
test them automatically every time a new stable GHC version is
released, which brings us to...

** Why Org instead of Markdown

Markdown is a pretty simple format and it doesn't have enough
syntax to represent the book's ~Tip~s, ~Warning~s and others. Also
Org allows us to [[https://orgmode.org/manual/Include-files.html][embed part of an external files]],
and that's how I plan to implement the automated testing at some
point.

Org files come from Emacs' [[https://orgmode.org][Org mode]], but
we don't need Emacs to edit them (I'm using [[https://github.com/jceb/vim-orgmode][Vim-OrgMode]]).

** Formatting

The source files should be readable without requiring to compile
them to HTML or other format, that's why [[http://webtypography.net/2.1.2][the maximum line length should be 66 characters]].
If you use [[http://editorconfig.org][Editorconfig]] you don't
have to worry about it. Sadly links cannot be split in multiple
lines, so they are the exception to the rule.

Once the Haskell code is extracted to their own files we should
agree on the format used there. Feel free to make suggestions.

** Git

For commit messages please follow [[https://chris.beams.io/posts/git-commit/#imperative][this guide]]
Also use descriptive names for branches.