Merge branch 'master' into 1950-inherited-tag-values

Shake.hs

@@ -762,18 +762,18 @@ main = do
 
       phony "orgfiles" $
         need [
-           ".BACKLOG.md"
-          ,".ROADMAP.md"
+           "doc/BACKLOG.md"
+          ,"doc/ROADMAP.md"
           ]
 
       -- These org files are converted to markdown for the website.
-      [ ".ROADMAP.md"
-       ,".BACKLOG.md"
+      [ "doc/ROADMAP.md"
+       ,"doc/BACKLOG.md"
        ] |%> \out -> do
-        let src = drop 1 out -<.> "org"
+        let src = out -<.> "org"
         need [src]
         -- replace the generated top heading with our own so we can insert the TOC after it
-        let heading = dropExtension $ drop 1 out
+        let heading = dropExtension out
         mdlines <- drop 1 . lines . fromStdout <$> (cmd Shell pandoc fromorg towebmd src :: Action (Stdout String))
         liftIO $ writeFile out $ unlines $ [
            "<!-- " ++ "Generated by \"Shake " ++ out ++ " from " ++ src ++ " -->"

doc/CONTRIBUTING.md

@@ -0,0 +1,142 @@
+# Contributor Quick Start
+
+<div class=pagetoc>
+
+<!-- toc -->
+</div>
+
+Here are some ways to contribute. Other content has moved elsewhere, see the DEVELOPERS section in the sidebar.
+
+## About the project
+
+### Mission
+
+Why was hledger created ?
+
+Mainly:
+
+- to provide a more usable, robust, documented, cross-platform-installable version of Ledger for users
+- to provide a more maintainable and hackable version of Ledger for developers 
+
+Also:
+
+- to provide a useful library and toolbox for finance-minded haskell programmers
+- to explore the suitability of Haskell for such applications
+- to experiment with building a successful time-and-money-solvent project in a thriving ecosystem of financial software projects
+
+What is the hledger project's current mission ?
+
+1. Provide peace of mind: bring clarity, relief, and peace of mind to folks stressed, confused, overwhelmed by finances.
+2. Educate and empower: help individuals and communities achieve clarity, accountability and mastery with money and time.
+
+### Roles and activities
+
+- newcomer/potential user
+- user
+- library user
+- field tester
+- bug wrangler
+- support
+- documentor
+- qa
+- developer
+- packager
+- communicator
+- project manager
+
+
+
+## Getting started
+
+New contributors are always welcome in the hledger project. 
+Jump in! Or [ask us](support.html) to help you find a task.
+
+### Funder
+
+Become a financial backer to
+sustain and grow this project,
+increase your influence,
+express gratitude,
+build prosperity consciousness,
+and help transform world finance!
+
+- Use the donate links on the [home page](https://hledger.org)
+- Configure a recurring donation
+- Contribute or pledge bounties on issues you care about
+- Ask your organization to contribute
+- Work on project sustainability, accountability, fundraising
+
+### Tester
+
+- Test installation on platforms you have access to
+- Test examples, advice, and links in the docs
+- Run the latest release or developer build in daily use
+- Run [tests](#run-package-tests)
+- Run [benchmarks](#run-package-benchmarks)
+- Report packaging, documentation, UX, functional, performance issues
+- Report and help analyse problems via irc/mail list/bug tracker
+
+When reporting bugs, don't forget to search the tracker for a similar bug report.
+Otherwise, open a new bug by clicking "New issue", or <http://bugs.hledger.org/new>.
+
+Enhancement requests are sometimes added to the tracker,but for these consider using
+the IRC channel and mail list (see [Getting help](index.html#getting-help)).
+Both are archived and linkable, so the idea won't be lost.
+There is also a collection of wishes at the old [trello board](http://trello.hledger.org).
+
+### Technical Writer
+
+- get familiar with the website and documentation online, review and test
+- get familiar with the site/doc source files (see [Shake.hs](#shake))
+- get the latest hledger source
+- send patches with names prefixed with "doc: " (or "site: ")
+
+### Graphics Designer
+
+- more/better logos & graphics
+- illustrations and diagrams
+- web design mockups for home page, site, hledger-web UI
+
+<!-- ### Product Designer -->
+### Communicator
+
+Marketing and market understanding is vital.
+
+- clarify project goals, value proposition, brand, mission, story
+- monitor product-market fit
+- identify new opportunities
+- influence developer priorities
+- spread the word!
+
+### Maintainer
+
+#### Help with issue management
+
+- watch tracker activity, report status
+- apply/update labels where needed
+- follow up on dormant issues
+- facilitate a consistently good bug-reporting & PR-contributing experience
+
+#### Help with packaging
+
+- package hledger for linux distros, macports, etc.
+- develop mac/windows installers
+- find and assist distro packagers/installer developers
+
+#### Help with project management
+
+- clarify/update goals and principles
+- monitor, report on project progress and performance
+- research, compare and report on successful projects, related projects
+- identify collaboration opportunities
+- marketing, communication, outreach
+- release management, roadmap planning
+
+### Developer
+
+See [Developer workflows](WORKFLOWS.md#developer-workflows).
+
+
+
+
+