git.iko.soy/rowtype-yoga/purescript-unique
on master help sign in
Updates for transfer to Rowtype Yoga organization
commit50e18dfe14082186abc103b3c969343cf998cad0 authorNick Saunders <nick@saunde.rs> dateSat 18 Mar 2023, 12:00 (4 years ago) parentf4c606d
3 files changed+66−18
compare with master
unifiedsplit
CHANGELOG.md+13−12 CONTRIBUTING.md+49−2 README.md+4−4
CHANGELOG.md+13−12
@@ -11,6 +11,7 @@ New features:
1111Bugfixes:
1212
1313Other improvements:
14+- Updated the project for its new home in the Rowtype Yoga organization.
1415
1516## [0.6.1] - 2023-03-18
1617
@@ -19,46 +20,46 @@ New features:
1920
2021Other improvements:
2122- Changed `Unique`'s runtime representation to a [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt). (#4 by @nsaunders)
22−- Updated the project to the standards of the [purescript-contrib](https://github.com/purescript-contrib) organization. ([8ec352b](https://github.com/nsaunders/purescript-unique/commit/8ec352ba1f7076c57c776872c2bc8ce7eb530e44) by @nsaunders)
23+- Updated the project to the standards of the [purescript-contrib](https://github.com/purescript-contrib) organization. ([8ec352b](https://github.com/rowtype-yoga/purescript-unique/commit/8ec352ba1f7076c57c776872c2bc8ce7eb530e44) by @nsaunders)
2324
2425## [0.6.0] - 2023-03-02
2526
2627Breaking changes:
27−- Updated to v0.15 of the compiler, dropping support for previous versions. ([7999c18](https://github.com/nsaunders/purescript-unique/commit/7999c1815adeb9011124c7d54902b55f18c8f295) by @nsaunders)
28+- Updated to v0.15 of the compiler, dropping support for previous versions. ([7999c18](https://github.com/rowtype-yoga/purescript-unique/commit/7999c1815adeb9011124c7d54902b55f18c8f295) by @nsaunders)
2829
2930## [0.5.1] - 2023-03-02
3031
3132Other improvements:
32−- Added `purs.json` file to facilitate package name transfer. ([4c40891](https://github.com/nsaunders/purescript-unique/commit/4c40891f563c3e5f212fe3b0cef4c0c28dd917b8) by @nsaunders)
33−- Added `LICENSE` file, determined from `bower.json`. ([2f3305c](https://github.com/nsaunders/purescript-unique/commit/2f3305cb511e6c270c25d53e6ebaaf3c193646ae) by @nsaunders)
33+- Added `purs.json` file to facilitate package name transfer. ([4c40891](https://github.com/rowtype-yoga/purescript-unique/commit/4c40891f563c3e5f212fe3b0cef4c0c28dd917b8) by @nsaunders)
34+- Added `LICENSE` file, determined from `bower.json`. ([2f3305c](https://github.com/rowtype-yoga/purescript-unique/commit/2f3305cb511e6c270c25d53e6ebaaf3c193646ae) by @nsaunders)
3435
3536## [0.5.0] - 2017-04-26
3637
3738Breaking changes:
38−- Updated to v0.11 of the compiler, dropping support for previous versions. ([33214fa](https://github.com/nsaunders/purescript-unique/commit/33214faf821843aad95a019ad0a4a28d2b305189) by @mechairoi)
39+- Updated to v0.11 of the compiler, dropping support for previous versions. ([33214fa](https://github.com/rowtype-yoga/purescript-unique/commit/33214faf821843aad95a019ad0a4a28d2b305189) by @mechairoi)
3940
4041## [0.4.0] - 2017-01-06
4142
4243Other improvements:
43−- Updated dependencies. ([03a24af](https://github.com/nsaunders/purescript-unique/commit/03a24af23dd9a64e08ff8a9f8d119437d2d9cf44) by @mechairoi)
44+- Updated dependencies. ([03a24af](https://github.com/rowtype-yoga/purescript-unique/commit/03a24af23dd9a64e08ff8a9f8d119437d2d9cf44) by @mechairoi)
4445
4546## [0.3.0] - 2016-06-28
4647
4748Breaking changes:
48−- Updated to v0.9 of the compiler, dropping support for previous versions. ([3a58d82](https://github.com/nsaunders/purescript-unique/commit/3a58d82f1d9b5942cc29f3a31979a10978797204) by @mechairoi)
49+- Updated to v0.9 of the compiler, dropping support for previous versions. ([3a58d82](https://github.com/rowtype-yoga/purescript-unique/commit/3a58d82f1d9b5942cc29f3a31979a10978797204) by @mechairoi)
4950
5051## [0.2.3] - 2016-05-04
5152
5253Breaking changes:
53−- Updated to v0.8 of the compiler, dropping support for previous versions. ([42fecfe](https://github.com/nsaunders/purescript-unique/commit/42fecfef16b3f54e7bf52ba8e882202f5f73fe6b) by @mechairoi)
54+- Updated to v0.8 of the compiler, dropping support for previous versions. ([42fecfe](https://github.com/rowtype-yoga/purescript-unique/commit/42fecfef16b3f54e7bf52ba8e882202f5f73fe6b) by @mechairoi)
5455
5556## [0.2.2] - 2016-02-12
5657
5758Bugfixes:
58−- Fixed `bower.json`. ([5048080](https://github.com/nsaunders/purescript-unique/commit/5048080a43a552e5a4786aff4bd4ae93816ade0f) by @mechairoi)
59+- Fixed `bower.json`. ([5048080](https://github.com/rowtype-yoga/purescript-unique/commit/5048080a43a552e5a4786aff4bd4ae93816ade0f) by @mechairoi)
5960
6061Other improvements:
61−- Updated to use Pursuit for docs. ([de69519](https://github.com/nsaunders/purescript-unique/commit/de695190c6bf43d827f0e63c0c99a6e080b262cc) by @mechairoi)
62+- Updated to use Pursuit for docs. ([de69519](https://github.com/rowtype-yoga/purescript-unique/commit/de695190c6bf43d827f0e63c0c99a6e080b262cc) by @mechairoi)
6263
6364## [0.2.1] - 2016-02-12
6465
@@ -67,12 +68,12 @@ No significant changes in this release.
6768## [0.2.0] - 2016-02-12
6869
6970Breaking changes:
70−- Renamed `Uniq` effect to `UNIQ`. ([4eeac9f](https://github.com/nsaunders/purescript-unique/commit/4eeac9f11f79b85bf8086d869ffa8fa56d9a9ec0) by @mechairoi)
71+- Renamed `Uniq` effect to `UNIQ`. ([4eeac9f](https://github.com/rowtype-yoga/purescript-unique/commit/4eeac9f11f79b85bf8086d869ffa8fa56d9a9ec0) by @mechairoi)
7172
7273## [0.1.0] - 2015-08-09
7374
7475Breaking changes:
75−- Updated to v0.7 of the compiler, dropping support for previous versions. ([d2b2873](https://github.com/nsaunders/purescript-unique/commit/d2b2873559a8c1bfe7dd3194a1614a77eac1a01e) by @mechairoi)
76+- Updated to v0.7 of the compiler, dropping support for previous versions. ([d2b2873](https://github.com/rowtype-yoga/purescript-unique/commit/d2b2873559a8c1bfe7dd3194a1614a77eac1a01e) by @mechairoi)
7677
7778## [0.0.1] - 2015-08-09
7879
CONTRIBUTING.md+49−2
@@ -1,3 +1,50 @@
1−# Contributing to Unique
1+Contributing
2+============
23
3−Thanks for your interest in contributing to `unique`! We welcome new contributions regardless of your level of experience or familiarity with PureScript.
4+Welcome, and thanks for your interest in Unique. Whether you are new to PureScript or here to teach us new tricks, we're glad to have you and look forward to your contributions. Listed below are a few ways you can help.
5+
6+Asking questions
7+----------------
8+If you have a question, please [open an issue](https://github.com/rowtype-yoga/purescript-unique/issues/new?labels=question) to discuss it. This might help us to find a defect; reveal an opportunity to improve the documentation or developer experience; or help someone facing a similar issue in the future.
9+
10+Reporting bugs
11+--------------
12+Please [open an issue](https://github.com/rowtype-yoga/purescript-unique/issues/new?labels=bug&template=bug-report.md) to discuss any defects you find.
13+
14+Enhancements
15+------------
16+Please [open an issue](https://github.com/rowtype-yoga/purescript-unique/issues/new?labels=enhancement&template=change-request.md) to discuss potential enhancements to the library. When submitting design ideas, please note that, for the most part, this library is intended as a direct port of the Haskell [`Data.Unique`](https://hackage.haskell.org/package/base-4.18.0.0/docs/Data-Unique.html) module.
17+
18+Improving documentation
19+-----------------------
20+Please share any suggestions for improving or adding to the documentation by [submitting a pull request](https://github.com/rowtype-yoga/purescript-unique/compare) or [opening an issue](https://github.com/rowtype-yoga/purescript-unique/issues/new?labels=documentation).
21+
22+Sharing resources
23+-----------------
24+If you have created a tutorial, auxiliary library, interesting code example, or other resource related to Unique, please [share it with the PureScript community](https://discourse.purescript.org). Increasing awareness will bring more users (and potential contributors) to the project.
25+
26+Submitting code
27+---------------
28+Pull requests are welcome, but we ask that you [open an issue](https://github.com/rowtype-yoga/purescript-unique/issues/new) to discuss your plans before making any significant investment of your valuable time.
29+
30+### Development environment
31+
32+You can use [Nix](https://github.com/NixOS/nix) to create a development environment with all required tooling. Simply run `nix-shell` in the root project directory, and you'll have everything you need to get started.
33+
34+### Making changes
35+
36+* After making any changes, run `purs-tidy format-in-place src test` to format the code.
37+* Unit test(s) should accompany each change.
38+
39+### Preparing your submission
40+
41+Please verify your changes before submitting a pull request using the following commands:
42+1. `purs-tidy check src test`, which ensures that modules in the `src` and `test` directories conform to the project's formatting standards; and
43+1. `spago -x test.dhall test`, which runs the unit tests.
44+
45+### Submitting a pull request
46+
47+When you are ready to [submit a pull request](https://github.com/rowtype-yoga/purescript-unique/compare), please make sure to include:
48+1. a brief description of the change;
49+1. a link to the related issue, if applicable; and
50+1. any design considerations you feel are important.
README.md+4−4
@@ -1,7 +1,7 @@
11# Unique
22
3−[![CI](https://github.com/nsaunders/purescript-unique/workflows/CI/badge.svg?branch=master)](https://github.com/nsaunders/purescript-unique/actions?query=workflow%3ACI+branch%3Amaster)
4−[![Release](https://img.shields.io/github/release/nsaunders/purescript-unique.svg)](https://github.com/nsaunders/purescript-unique/releases)
3+[![CI](https://github.com/rowtype-yoga/purescript-unique/workflows/CI/badge.svg?branch=master)](https://github.com/rowtype-yoga/purescript-unique/actions?query=workflow%3ACI+branch%3Amaster)
4+[![Release](https://img.shields.io/github/release/rowtype-yoga/purescript-unique.svg)](https://github.com/rowtype-yoga/purescript-unique/releases)
55[![Pursuit](https://pursuit.purescript.org/packages/purescript-unique/badge)](https://pursuit.purescript.org/packages/purescript-unique)
66[![Maintainer: nsaunders](https://img.shields.io/badge/maintainer-nsaunders-teal.svg)](https://github.com/nsaunders)
77
@@ -29,14 +29,14 @@ The quick start hasn't been written yet (contributions are welcome!). The quick
2929
3030If you get stuck, there are several ways to get help:
3131
32−- [Open an issue](https://github.com/nsaunders/purescript-unique/issues) if you have encountered a bug or problem.
32+- [Open an issue](https://github.com/rowtype-yoga/purescript-unique/issues) if you have encountered a bug or problem.
3333- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://discord.com/invite/sMqwYUbvz6) chat.
3434
3535## Contributing
3636
3737You can contribute to `unique` in several ways:
3838
39−1. If you encounter a problem or have a question, please [open an issue](https://github.com/nsaunders/purescript-unique/issues). We'll do our best to work with you to resolve or answer it.
39+1. If you encounter a problem or have a question, please [open an issue](https://github.com/rowtype-yoga/purescript-unique/issues). We'll do our best to work with you to resolve or answer it.
4040
41412. 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.
4242