Skip to content

Rearrange changelog and contributing docs #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Changelog

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

## [Unreleased]

Breaking changes (😱!!!):

New features:

Bugfixes:

Other improvements:

## [v4.1.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v4.1.1) - 2019-01-12

- Expand documentation

## [v4.1.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v4.1.0) - 2018-09-09

- Export `null` and `notNull` (@bklaric)

## [v4.0.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v4.0.0) - 2018-05-24

- Updated for PureScript 0.12

## [v3.0.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v3.0.0) - 2017-04-02

- Updates for 0.11 compiler

## [v2.0.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v2.0.0) - 2016-10-17

- Updated dependencies

## [v1.0.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v1.0.1) - 2016-06-13

- Fix `bower.json` (@kika)

## [v1.0.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v1.0.0) - 2016-06-02

- Updates for 1.0 core libraries.

## [v0.2.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.2.1) - 2015-07-24

- Fix `null` issue spotted by @Javran.

## [v0.2.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.2.0) - 2015-06-30

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

## [v0.2.0-rc.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.2.0-rc.1) - 2015-06-19

- Release for the 0.7 compiler.

## [v0.1.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.1.1) - 2015-03-07

- Handle `undefined`.

## [v0.1.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.1.0) - 2015-01-29

- Initial release

File renamed without changes.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The quick start hasn't been written yet (contributions are welcome!). The quick
`nullable` documentation is stored in a few places:

1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-nullable).
2. Written documentation and [the changelog](./docs/CHANGELOG.md) are kept in [the docs directory](./docs).
2. Written documentation is kept in the [docs directory](./docs).
3. Usage examples can be found in [the test suite](./test).

If you get stuck, there are several ways to get help:
Expand All @@ -38,6 +38,6 @@ You can contribute to `nullable` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-nullable/issues). We'll do our best to work with you to resolve or answer it.

2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./.github/CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.
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.

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.
15 changes: 0 additions & 15 deletions docs/CHANGELOG.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Nullable Documentation

This directory contains documentation for `nullable`. If you are interested in contributing new documentation, please read the [contributor guidelines](../.github/CONTRIBUTING.md) and [What Nobody Tells You About Documentation](https://documentation.divio.com) for help getting started.
This directory contains documentation for `nullable`. If you are interested in contributing new documentation, please read the [contributor guidelines](../CONTRIBUTING.md) and [What Nobody Tells You About Documentation](https://documentation.divio.com) for help getting started.