Update for contributors library requirements (#11)

thomashoneyman · web-flow · commit e89420a42740 · 2020-10-06T09:08:54.000-07:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,13 @@
+# https://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,19 @@
+---
+name: Bug report
+about: Report an issue
+title: ""
+labels: bug
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of the bug.
+
+**To Reproduce**
+A minimal code example (preferably a runnable example on [Try PureScript](https://try.purescript.org)!) or steps to reproduce the issue.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/change-request.md b/.github/ISSUE_TEMPLATE/change-request.md
@@ -0,0 +1,21 @@
+---
+name: Change request
+about: Propose an improvement to this library
+title: ""
+labels: ""
+assignees: ""
+---
+
+**Is your change request related to a problem? Please describe.**
+A clear and concise description of the problem.
+
+Examples:
+
+- It's frustrating to have to [...]
+- I was looking for a function to [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what a good solution to you looks like, including any solutions you've already considered.
+
+**Additional context**
+Add any other context about the change request here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: PureScript Discourse
+    url: https://discourse.purescript.org/
+    about: Ask and answer questions here.
+  - name: Functional Programming Slack
+    url: https://functionalprogramming.slack.com
+    about: For casual chat and questions (use https://fpchat-invite.herokuapp.com to join).
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+**Description of the change**
+Clearly and concisely describe the purpose of the pull request. If this PR relates to an existing issue or change proposal, please link to it. Include any other background context that would help reviewers understand the motivation for this PR.
+
+---
+
+**Checklist:**
+
+- [ ] Added the change to the changelog's "Unreleased" section with a link to this PR and your username
+- [ ] Linked any existing issues or proposals that this pull request should close
+- [ ] Updated or added relevant documentation in the README and/or documentation directory
+- [ ] Added a test for the contribution (if applicable)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up a PureScript toolchain
+        uses: purescript-contrib/setup-purescript@main
+
+      - name: Cache PureScript dependencies
+        uses: actions/cache@v2
+        with:
+          key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
+          path: |
+            .spago
+            output
+
+      - name: Install dependencies
+        run: spago install
+
+      - name: Build source
+        run: spago build --no-install --purs-args '--censor-lib --strict'
+
+      - name: Run tests
+        run: spago test --no-install
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,8 @@
-/.*
-!/.gitignore
-!/.travis.yml
-/bower_components/
-/node_modules/
-/output/
-package-lock.json
+.*
+!.gitignore
+!.github
+!.editorconfig
+
+output
+generated-docs
+bower_components
diff --git a/.travis.yml b/.travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,33 @@
+# Changelog
+
+Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Breaking changes (😱!!!):
+
+New features:
+
+Bugfixes:
+
+Other improvements:
+
+## [v4.0.0](https://github.com/purescript-contrib/purescript-fork/releases/tag/v4.0.0) - 2018-05-27
+
+- Updated for PureScript 0.12
+
+## [v3.0.0](https://github.com/purescript-contrib/purescript-fork/releases/tag/v3.0.0) - 2017-09-14
+
+- Reformulated hierarchy with `MonadFork`, `MonadKill`, and `MonadBracket`.
+
+## [v2.0.0](https://github.com/purescript-contrib/purescript-fork/releases/tag/v2.0.0) - 2017-04-04
+
+- Updated dependencies for PureScript 0.11
+
+## [v1.1.0](https://github.com/purescript-contrib/purescript-fork/releases/tag/v1.1.0) - 2016-11-22
+
+- Added `Canceler` semigroup
+
+## [v1.0.0](https://github.com/purescript-contrib/purescript-fork/releases/tag/v1.0.0) - 2016-11-19
+
+- Initial release.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+# Contributing to Fork
+
+Thanks for your interest in contributing to `fork`! We welcome new contributions regardless of your level of experience or familiarity with PureScript.
+
+Every library in the Contributors organization shares a simple handbook that helps new contributors get started. With that in mind, please [read the short contributing guide on purescript-contrib/governance](https://github.com/purescript-contrib/governance/blob/main/contributing.md) before contributing to this library.
diff --git a/README.md b/README.md
@@ -1,16 +1,44 @@
-# purescript-fork
+# Fork
 
-[![Latest release](http://img.shields.io/github/release/slamdata/purescript-fork.svg)](https://github.com/slamdata/purescript-fork/releases)
-[![Build status](https://travis-ci.org/slamdata/purescript-fork.svg?branch=master)](https://travis-ci.org/slamdata/purescript-fork)
+[![CI](https://github.com/purescript-contrib/purescript-fork/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-fork/actions?query=workflow%3ACI+branch%3Amain)
+[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-fork.svg)](https://github.com/purescript-contrib/purescript-fork/releases)
+[![Pursuit](https://pursuit.purescript.org/packages/purescript-fork/badge)](https://pursuit.purescript.org/packages/purescript-fork)
+[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-teal.svg)](https://github.com/garyb)
+[![Maintainer: thomashoneyman](https://img.shields.io/badge/maintainer-thomashoneyman-teal.svg)](https://github.com/thomashoneyman)
 
-Forkable monads.
+Monads which support a forking operation.
 
 ## Installation
 
+Install `fork` with [Spago](https://github.com/purescript/spago):
+
+```sh
+spago install fork
 ```
-bower install purescript-fork
-```
+
+## Quick start
+
+The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the [docs directory](./docs).
 
 ## Documentation
 
-- Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-fork).
+`fork` documentation is stored in a few places:
+
+1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-fork).
+2. Written documentation is kept in the [docs directory](./docs).
+3. Usage examples can be found in [the test suite](./test).
+
+If you get stuck, there are several ways to get help:
+
+- [Open an issue](https://github.com/purescript-contrib/purescript-fork/issues) if you have encountered a bug or problem.
+- [Search or start a thread on the PureScript Discourse](https://discourse.purescript.org) if you have general questions. You can also ask questions in the `#purescript` and `#purescript-beginners` channels on the [Functional Programming Slack](https://functionalprogramming.slack.com) ([invite link](https://fpchat-invite.herokuapp.com/)).
+
+## Contributing
+
+You can contribute to `fork` in several ways:
+
+1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-fork/issues). We'll do our best to work with you to resolve or answer it.
+
+2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.
+
+3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the [PureScript Discourse](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+# Fork Documentation
+
+This directory contains documentation for `fork`. If you are interested in contributing new documentation, please read the [contributor guidelines](../CONTRIBUTING.md) and [What Nobody Tells You About Documentation](https://documentation.divio.com) for help getting started.
diff --git a/package.json b/package.json
diff --git a/packages.dhall b/packages.dhall
@@ -0,0 +1,4 @@
+let upstream =
+      https://github.com/purescript/package-sets/releases/download/psc-0.13.8-20200922/packages.dhall sha256:5edc9af74593eab8834d7e324e5868a3d258bbab75c5531d2eb770d4324a2900
+
+in  upstream
diff --git a/spago.dhall b/spago.dhall
@@ -0,0 +1,5 @@
+{ name = "fork"
+, dependencies = [ "aff", "console", "effect", "psci-support" ]
+, packages = ./packages.dhall
+, sources = [ "src/**/*.purs", "test/**/*.purs" ]
+}
diff --git a/src/Control/Monad/Fork/Class.purs b/src/Control/Monad/Fork/Class.purs
@@ -1,19 +1,3 @@
-{-
-Copyright 2017 SlamData, Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--}
-
 module Control.Monad.Fork.Class where
 
 import Prelude hiding (join)
diff --git a/test/Main.purs b/test/Main.purs
@@ -0,0 +1,11 @@
+module Test.Main where
+
+import Prelude
+
+import Effect (Effect)
+import Effect.Class.Console (log)
+
+main :: Effect Unit
+main = do
+  log "🍝"
+  log "You should add some tests."
