Skip to content

Commit be63aa4

Browse files
thomashoneymanthomashoneyman
committed
Scaffold the library (CI, README, etc.)
1 parent 8f4d1d6 commit be63aa4

File tree

15 files changed

+216
-0
lines changed

15 files changed

+216
-0
lines changed

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# https://editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Bug report
3+
about: Report an issue
4+
title: ""
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of the bug.
11+
12+
**To Reproduce**
13+
A minimal code example (preferably a runnable example on [Try PureScript](https://try.purescript.org)!) or steps to reproduce the issue.
14+
15+
**Expected behavior**
16+
A clear and concise description of what you expected to happen.
17+
18+
**Additional context**
19+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/change-request.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Change request
3+
about: Propose an improvement to this library
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
**Is your change request related to a problem? Please describe.**
10+
A clear and concise description of the problem.
11+
12+
Examples:
13+
14+
- It's frustrating to have to [...]
15+
- I was looking for a function to [...]
16+
17+
**Describe the solution you'd like**
18+
A clear and concise description of what a good solution to you looks like, including any solutions you've already considered.
19+
20+
**Additional context**
21+
Add any other context about the change request here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: PureScript Discourse
4+
url: https://discourse.purescript.org/
5+
about: Ask and answer questions here.
6+
- name: Functional Programming Slack
7+
url: https://functionalprogramming.slack.com
8+
about: For casual chat and questions (use https://fpchat-invite.herokuapp.com to join).

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
**Description of the change**
2+
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.
3+
4+
---
5+
6+
**Checklist:**
7+
8+
- [ ] Added the change to the changelog's "Unreleased" section with a link to this PR and your username
9+
- [ ] Linked any existing issues or proposals that this pull request should close
10+
- [ ] Updated or added relevant documentation in the README and/or documentation directory
11+
- [ ] Added a test for the contribution (if applicable)

‎.github/workflows/ci.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2
14+
15+
- name: Set up a PureScript toolchain
16+
uses: purescript-contrib/setup-purescript@main
17+
18+
- name: Cache PureScript dependencies
19+
uses: actions/cache@v2
20+
with:
21+
key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
22+
path: |
23+
.spago
24+
output
25+
26+
- name: Install dependencies
27+
run: |
28+
bower install
29+
spago install
30+
31+
- name: Build source
32+
run: |
33+
pulp build
34+
spago build --no-install --purs-args '--censor-lib --strict'
35+
36+
- name: Run tests
37+
run: spago test --no-install

‎.gitignore‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.*
2+
!.gitignore
3+
!.github
4+
!.editorconfig
5+
6+
output
7+
generated-docs
8+
bower_components
9+
node_modules
10+
11+
package-lock.json
12+
*.lock

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
Notable changes to `halogen-emitter` 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).
4+
5+
## [Unreleased]
6+
7+
Breaking changes:
8+
9+
New features:
10+
11+
Bugfixes:
12+
13+
Other improvements:

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing to Halogen Emitter
2+
3+
Thanks for your interest in contributing to `halogen-emitter`! We welcome new contributions regardless of your level of experience or familiarity with PureScript.
4+
5+
We share the simple handbook that libraries in the PureScript Contributors organization use. 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.

‎README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Halogen Emitter
2+
3+
[![CI](https://github.com/purescript-contrib/purescript-halogen-emitter/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-halogen-emitter/actions?query=workflow%3ACI+branch%3Amain)
4+
[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-halogen-emitter.svg)](https://github.com/purescript-contrib/purescript-halogen-emitter/releases)
5+
[![Pursuit](https://pursuit.purescript.org/packages/purescript-halogen-emitter/badge)](https://pursuit.purescript.org/packages/purescript-halogen-emitter)
6+
[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-teal.svg)](https://github.com/garyb)
7+
[![Maintainer: thomashoneyman](https://img.shields.io/badge/maintainer-thomashoneyman-teal.svg)](https://github.com/thomashoneyman)
8+
9+
The library summary hasn't been written yet (contributions are welcome!). The library summary describes the library's purpose in one to three sentences.
10+
11+
## Installation
12+
13+
Install `halogen-emitter` with [Spago](https://github.com/purescript/spago):
14+
15+
```sh
16+
spago install halogen-emitter
17+
```
18+
19+
## Quick start
20+
21+
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).
22+
23+
## Documentation
24+
25+
`halogen-emitter` documentation is stored in a few places:
26+
27+
1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-halogen-emitter).
28+
2. Written documentation is kept in the [docs directory](./docs).
29+
3. Usage examples can be found in [the test suite](./test).
30+
31+
If you get stuck, there are several ways to get help:
32+
33+
- [Open an issue](https://github.com/purescript-contrib/purescript-halogen-emitter/issues) if you have encountered a bug or problem.
34+
- [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/)).
35+
36+
## Contributing
37+
38+
You can contribute to `halogen-emitter` in several ways:
39+
40+
1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-halogen-emitter/issues). We'll do our best to work with you to resolve or answer it.
41+
42+
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.
43+
44+
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.

0 commit comments

Comments
 (0)