Permalink
Browse files

Docs about external dependencies

  • Loading branch information...
dahlia committed Aug 21, 2017
1 parent e6715fb commit 1bfb98d9d4098bb496eff8507fe2141909fc4c47
Showing with 32 additions and 0 deletions.
  1. +14 −0 CONTRIBUTING.md
  2. +18 −0 app/test-targets.hs
View
@@ -68,3 +68,17 @@ changes breaking either testing cannot be merged.
[ci]: https://travis-ci.org/spoqa/nirum
[ciw-svg]: https://ci.appveyor.com/api/projects/status/jf9bsrnalcb1xrp0?svg=true
[ciw]: https://ci.appveyor.com/project/dahlia/nirum-k5n5y
External dependencies
---------------------
Each target test suite has its external dependencies (i.e. non-library program
dependencies):
- Python
- All Python versions that Nirum should support: Python 2.7, and
3.4---3.5
- [`tox`][tox]
[tox]: https://tox.readthedocs.io/
View
@@ -1,4 +1,22 @@
{-# LANGUAGE OverloadedStrings, QuasiQuotes #-}
-- How to add a test suite for a new target
--
-- a. Define a function of the same name to the target name
-- (i.e. `targetName :: Target t => Proxy t -> TargetName`),
-- which is a type of `IO ()`. See `python :: IO ()` for example.
--
-- b. If a test suite requires any external programs list them
-- in "External dependencies" section of CONTRIBUTING.md docs.
--
-- c. Add the defined function to `do` block of `main` function.
-- Please keep functions in lexicographical order.
--
-- d. If an action is necessary for only CI builds invoke it using
-- `whenCi :: IO () -> IO ()`.
--
-- e. This script is written in Turtle, a DSL embeded in Haskell for
-- shell scripting.
-- See also <https://github.com/Gabriel439/Haskell-Turtle-Library>.
import Control.Monad (when)
import System.Environment (lookupEnv)
import System.IO.Error (catchIOError, isDoesNotExistError)

0 comments on commit 1bfb98d

Please sign in to comment.