Skip to content

Commit e9e801a

Browse files
thomashoneymanthomashoneyman
authored
Update for Contributors library guidelines (#176)
1 parent 74f74f4 commit e9e801a

17 files changed

+682
-274
lines changed

Diff for: ‎.editorconfig

+13
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

Diff for: ‎.eslintrc.json

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"env": { "commonjs": true },
3+
"extends": "eslint:recommended",
4+
"parserOptions": { "ecmaVersion": 5 },
5+
"rules": {
6+
"block-scoped-var": "error",
7+
"consistent-return": "error",
8+
"eqeqeq": "error",
9+
"guard-for-in": "error",
10+
"no-bitwise": "error",
11+
"no-caller": "error",
12+
"no-extra-parens": "off",
13+
"no-extend-native": "error",
14+
"no-loop-func": "error",
15+
"no-new": "error",
16+
"no-param-reassign": "error",
17+
"no-return-assign": "error",
18+
"no-sequences": "error",
19+
"no-unused-expressions": "error",
20+
"no-use-before-define": "error",
21+
"no-undef": "error",
22+
"no-eq-null": "error",
23+
"radix": ["error", "always"],
24+
"indent": ["error", 2, { "SwitchCase": 1 }],
25+
"quotes": ["error", "double"],
26+
"semi": ["error", "always"],
27+
"strict": ["error", "global"]
28+
}
29+
}

Diff for: ‎.github/ISSUE_TEMPLATE/bug-report.md

+19
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.

Diff for: ‎.github/ISSUE_TEMPLATE/change-request.md

+21
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.

Diff for: ‎.github/ISSUE_TEMPLATE/config.yml

+8
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).

Diff for: ‎.github/PULL_REQUEST_TEMPLATE.md

+11
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)

Diff for: ‎.github/workflows/ci.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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 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: Set up Node toolchain
28+
uses: actions/setup-node@v1
29+
with:
30+
node-version: "12.x"
31+
32+
- name: Cache NPM dependencies
33+
uses: actions/cache@v2
34+
env:
35+
cache-name: cache-node-modules
36+
with:
37+
path: ~/.npm
38+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package.json') }}
39+
restore-keys: |
40+
${{ runner.os }}-build-${{ env.cache-name }}-
41+
${{ runner.os }}-build-
42+
${{ runner.os }}-
43+
44+
- name: Install NPM dependencies
45+
run: npm install
46+
47+
- name: Build the project
48+
run: npm run build
49+
50+
- name: Run tests
51+
run: npm run test

Diff for: ‎.gitignore

+13-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
.psci*
2-
bower_components/
3-
node_modules/
4-
output/
5-
yarn-error.log
6-
.psc-package
7-
.psc-ide-port
1+
.*
2+
!.gitignore
3+
!.github
4+
!.editorconfig
5+
!.eslintrc.json
6+
7+
output
8+
generated-docs
9+
bower_components
10+
11+
node_modules
12+
package-lock.json
13+
*.lock

Diff for: ‎CHANGELOG.md

+194
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
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+
## [v8.0.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v8.0.0) - 2019-08-10
16+
17+
**Breaking changes**
18+
19+
- #172 add `createRef` support @elliotdavies
20+
21+
## [v7.0.1](https://github.com/purescript-contrib/purescript-react/releases/tag/v7.0.1) - 2019-05-27
22+
23+
- Relax upper bound on `purescript-typelevel-prelude` (@hdgarrood)
24+
25+
## [v7.0.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v7.0.0) - 2019-05-17
26+
27+
**Breaking Changes**
28+
29+
- #169 Bump dependency (@bbarker)
30+
31+
**Documentation**
32+
33+
- #165 Update documentation (@athanclark)
34+
35+
## [v6.1.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v6.1.0) - 2018-08-24
36+
37+
**Features**
38+
- #155 export react types (@tellnobody1)
39+
40+
## [v6.0.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v6.0.0) - 2018-06-09
41+
42+
**Breaking Changes**
43+
- Alternative class construction #129 (@natefaubion)
44+
- Replace ReactRender with IsReactElement #137 (@natefaubion)
45+
- Event refactoring #144 (@ethul)
46+
- Remove children for void DOM elements #145, #146 (@ethul)
47+
- Updates for PureScript 0.12, including the Context API, and unsafe createElement variants #149 (@natefaubion)
48+
49+
**Features**
50+
- Add onError #133 (@safareli)
51+
52+
## [v5.1.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v5.1.0) - 2017-12-16
53+
54+
**Features**
55+
56+
- #130 Adds value array for multiselect (@tellnobody1)
57+
58+
## [v5.0.1](https://github.com/purescript-contrib/purescript-react/releases/tag/v5.0.1) - 2017-11-21
59+
60+
**Fixes**
61+
62+
- #125 `writeRef` writes directly to `this`.
63+
64+
## [v5.0.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v5.0.0) - 2017-11-02
65+
66+
**Breaking**
67+
68+
- #109 React 16 (@coot)
69+
- #121 Fix event type functions (@spicydonuts)
70+
71+
## [v4.4.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v4.4.0) - 2017-10-11
72+
73+
**Features**
74+
75+
- #100 refs (@coot)
76+
77+
## [v4.3.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v4.3.0) - 2017-09-06
78+
79+
**Features**
80+
81+
- #114 Add common SVG elements (@evenchange4)
82+
83+
**Documentation**
84+
85+
- #115 Update maintainers (@paf31)
86+
87+
## [v4.2.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v4.2.0) - 2017-08-29
88+
89+
**Features**
90+
91+
- #112 Add SVG element `foreignObject` (@paulyoung)
92+
- #113 Add SVG attributes `x` and `y` (@paulyoung)
93+
94+
**Fixes**
95+
96+
- #110 Update badge version in README (@coot)
97+
- #111 Correct documentation link (@nwolverson)
98+
99+
## [v4.1.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v4.1.0) - 2017-08-10
100+
101+
**Features**
102+
103+
- #103 Force update (@coot)
104+
- #107 Export `childrenToArray` (@coot)
105+
106+
## [v4.0.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v4.0.0) - 2017-06-27
107+
108+
Updates for React 15 (@coot)
109+
110+
## [v3.0.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v3.0.0) - 2017-03-29
111+
112+
Updates for 0.11.1 compiler release.
113+
114+
## [v1.3.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v1.3.0) - 2016-09-17
115+
116+
Add simpler props-free versions of SVG functions (@joshuahhh)
117+
118+
## [v1.2.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v1.2.0) - 2016-09-11
119+
120+
Add `preventDefault` and `stopPropagation` (@teh).
121+
122+
## [v1.1.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v1.1.0) - 2016-06-12
123+
124+
Add a variant of `writeState` with a callback (@pkamenarsky)
125+
126+
## [v1.0.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v1.0.0) - 2016-06-11
127+
128+
- Updates for 1.0 core libraries and 0.9.1 compiler. This library will not work with compiler versions < 0.9.1. (@spicydonuts)
129+
130+
## [v0.7.1](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.7.1) - 2016-03-14
131+
132+
**Bug Fixes**
133+
134+
#70 - Fixes `aria` and `data` props
135+
136+
## [v0.7.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.7.0) - 2016-02-29
137+
138+
**Features**
139+
140+
#62 - Fix transform state (@spencerjanssen)
141+
#63 - Stateless components with children (@ethul)
142+
143+
## [v0.6.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.6.0) - 2016-01-25
144+
145+
**Features**
146+
147+
#54 - Dynamic children support
148+
#56 - Bindings for React 0.14
149+
150+
**Breaking Changes**
151+
152+
The `react` library is now explicitly required in the FFI code. `purescript-react` no longer assumes that `React` is globally available. Also, with the support for 0.14 bindings of React, the DOM bindings have been split out into a separate repository [purescript-react-dom](https://github.com/purescript-contrib/purescript-react-dom).
153+
154+
## [v0.5.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.5.0) - 2015-11-19
155+
156+
- Simplify effect types for read/write access.
157+
158+
## [v0.4.3](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.4.3) - 2015-10-18
159+
160+
Add `GetInitialState` argument in `spec'` (@ethul)
161+
162+
## [v0.4.2](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.4.2) - 2015-10-01
163+
164+
Fix inline styling error (@robkuz)
165+
166+
## [v0.4.1](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.4.1) - 2015-09-24
167+
168+
Fix a bug in `getChildren` (@ethul)
169+
170+
## [v0.4.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.4.0) - 2015-09-04
171+
172+
Add state and props to `ReactThis` (@ethul)
173+
174+
## [v0.3.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.3.0) - 2015-09-01
175+
176+
Support React 0.13.\* (@ethul)
177+
178+
## [v0.2.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.2.0) - 2015-08-31
179+
180+
Add additional arguments to lifecycle methods (@ethul)
181+
182+
## [v0.1.2](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.1.2) - 2015-08-12
183+
184+
Support `displayName` (@ethul)
185+
186+
## [v0.1.1](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.1.1) - 2015-07-29
187+
188+
Fix `bower.json` file.
189+
190+
## [v0.1.0](https://github.com/purescript-contrib/purescript-react/releases/tag/v0.1.0) - 2015-07-02
191+
192+
This release works with versions 0.7.\* of the PureScript compiler. It will not work with older versions. If you are using an older version, you should require an older, compatible version of this library.
193+
- Break up `React.DOM` module
194+
- Make `this` reference explicit

Diff for: ‎CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing to React
2+
3+
Thanks for your interest in contributing to `react`! 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)