Skip to content

Commit 27e4739

Browse files
thomashoneymanthomashoneyman
authored
Update according to Contributors library guidelines (#41)
1 parent c6bab94 commit 27e4739

File tree

15 files changed

+250
-62
lines changed

15 files changed

+250
-62
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
32+
33+
- name: Run tests
34+
run: spago test --no-install

‎.gitignore

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
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
16-
package-lock.json
17-
*.lock
8+
bower_components

‎.travis.yml

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

‎CHANGELOG.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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+
## [v7.0.1](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v7.0.1) - 2019-06-04
16+
17+
- Updated for PureScript 0.13 compatibility
18+
19+
## [v7.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v7.0.0) - 2019-03-04
20+
21+
- Updated dependencies
22+
23+
## [v6.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v6.0.0) - 2018-06-28
24+
25+
- Updates for [email protected] @therealnicksaunders
26+
27+
## [v5.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v5.0.0) - 2018-03-20
28+
29+
- Remove `Sandboxed` slot from `Pathy` type.
30+
- Add better way of Sandboxing.
31+
- Use `NonEmptyString` for segment names.
32+
- Make runtime representation of Pathy simpler.
33+
- And bunch more, see #33 (@safareli, @garyb)
34+
35+
## [v4.1.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v4.1.0) - 2017-12-21
36+
37+
- Add Gen module - @safareli #31
38+
39+
## [v4.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v4.0.0) - 2017-04-04
40+
41+
- Updated for PureScript 0.11
42+
- Removed deprecated `Data.Generic` instances.
43+
44+
## [v3.0.2](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v3.0.2) - 2016-12-21
45+
46+
- Fixed shadowed name warning
47+
- Fixed license identifier for Pursuit publishing
48+
49+
## [v3.0.1](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v3.0.1) - 2016-11-14
50+
51+
- Fixed `Ord` instance
52+
53+
## [v3.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v3.0.0) - 2016-10-28
54+
55+
- Updated dependencies for PureScript 0.10
56+
57+
## [v2.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v2.0.0) - 2016-07-28
58+
59+
- The `Escaper` is no longer ignored when printing paths
60+
- Directories are consistently on the left and files consistently on the right in `Either`s and function arguments now
61+
62+
## [v0.3.3](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.3.3) - 2016-04-21
63+
64+
- Fix the exports for v0.3.2
65+
66+
## [v0.3.2](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.3.2) - 2016-04-21
67+
68+
- Added synonyms for where a path is either a directory or file.
69+
- Added `pathName` to extract the name of a directory or file.
70+
71+
## [v0.3.1](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.3.1) - 2016-01-21
72+
73+
- Fixed various warnings raised by psc 0.7.6.1
74+
75+
## [v0.2.1](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.2.1) - 2015-08-14
76+
77+
- Functionally identical to v0.2.0, this update is to allow publishing on http://pursuit.purescript.org/
78+
79+
## [v0.1.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.1.0) - 2015-04-29
80+
81+
- Initial release

‎CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing to Pathy
2+
3+
Thanks for your interest in contributing to `pathy`! 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)