Skip to content

Commit b029f20

Browse files
maxdeviantmaxdeviant
authored
Update according to Contributors library guidelines (#75)
1 parent 1ddfe9c commit b029f20

File tree

16 files changed

+287
-54
lines changed

16 files changed

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

‎.gitignore‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,13 @@
1-
/.*
2-
!/.gitignore
3-
!/.github
4-
!/.travis.yml
1+
.*
2+
!.gitignore
3+
!.github
4+
!.editorconfig
55

6-
# Dependencies
7-
bower_components
8-
node_modules
9-
10-
# Generated files
116
output
12-
dce-output
137
generated-docs
14-
15-
# Lockfiles
8+
bower_components
9+
node_modules
1610
package-lock.json
17-
*.lock
1811

1912
# Extra files
2013
public/test.js

‎.travis.yml‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Changelog
2+
3+
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).
4+
5+
## [Unreleased]
6+
7+
Breaking changes (😱!!!):
8+
9+
New features:
10+
11+
Bugfixes:
12+
13+
Other improvements:
14+
15+
## [v9.0.1](https://github.com/purescript-contrib/purescript-routing/releases/tag/v9.0.1) - 2020-02-09
16+
17+
- Bug fix: `param` will now remove `Query` from the internal state once all parameters have been consumed, allowing `end` to be used to disallow further parameters.
18+
19+
## [v9.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v9.0.0) - 2019-03-12
20+
21+
- Updated dependencies
22+
23+
## [v8.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v8.0.0) - 2018-05-28
24+
25+
- Updates for 0.12 and `Effect`.
26+
- Removed `Match` class.
27+
28+
## [v7.1.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v7.1.0) - 2018-03-22
29+
30+
- Added matcher for `NonEmptyString`
31+
- Re-exported `Routing.Match.Class` matchers from `Routing.Match`
32+
- Added `Routing.PushState` module for using the browser's `pushState` interface instead of hash routing.
33+
34+
## [v7.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v7.0.0) - 2018-01-28
35+
36+
- Removes FFI
37+
- Removes Aff functions
38+
- Adds general `foldHashes`
39+
- Removes `hashChanged`
40+
- Changes the way `matches` works (filters failures)
41+
42+
@natefaubion
43+
44+
## [v6.1.2](https://github.com/purescript-contrib/purescript-routing/releases/tag/v6.1.2) - 2017-10-18
45+
46+
- Fix for parsing of URI-encoded path segments without query fragments
47+
48+
## [v6.1.1](https://github.com/purescript-contrib/purescript-routing/releases/tag/v6.1.1) - 2017-10-10
49+
50+
- Fixed behaviour of query parsing so that everything past the first `?` is parsed as a query string
51+
52+
## [v6.1.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v6.1.0) - 2017-10-03
53+
54+
- Added `Eq` and `Ord` instances for `RoutePart` (@coot)
55+
56+
## [v6.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v6.0.0) - 2017-09-23
57+
58+
- Updated for `purescript-aff` v4.x
59+
- Altered parsing to capture query params without a trailing `/` #37
60+
- Added `optionalMatch`
61+
62+
All updates courtesy of @coot
63+
64+
## [v5.1.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v5.1.0) - 2017-04-21
65+
66+
- Added `end` combinator @throughnothing
67+
68+
## [v5.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v5.0.0) - 2017-04-10
69+
70+
- Updates for PureScript 0.11 (@coot)
71+
72+
## [v4.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v4.0.0) - 2017-02-22
73+
74+
- Renamed `matchHash` and `matchHash'` to `match` and `matchWith`
75+
76+
## [v3.1.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v3.1.0) - 2017-02-18
77+
78+
- Added support for matching integers in paths (@menelaos)
79+
80+
## [v3.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v3.0.0) - 2016-11-03
81+
82+
- Updated for PureScript 0.10
83+
84+
## [v2.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v2.0.0) - 2016-07-31
85+
86+
- Updated dependencies
87+
88+
## [v1.0.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v1.0.0) - 2016-07-04
89+
90+
Updated for PureScript 0.9 and core libraries 1.0.
91+
92+
## [v0.4.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v0.4.0) - 2016-03-13
93+
94+
- Updated to latest `purescript-aff`
95+
96+
## [v0.2.1](https://github.com/purescript-contrib/purescript-routing/releases/tag/v0.2.1) - 2015-12-16
97+
98+
## [v0.2.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v0.2.0) - 2015-09-23
99+
100+
## [v0.1.0](https://github.com/purescript-contrib/purescript-routing/releases/tag/v0.1.0) - 2015-07-10

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing to Routing
2+
3+
Thanks for your interest in contributing to `routing`! We welcome new contributions regardless of your level of experience or familiarity with PureScript.
4+
5+
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.

0 commit comments

Comments
 (0)