You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thanks for your interest in contributing to argonaut-codecs! This file is a short, sweet introduction to contributing to this project. We ask that all new contributors read it before their first contribution to make sure we can get your work merged.
3
+
Thanks for your interest in contributing to `argonaut-codecs`! We welcome new contributions regardless of your level of experience or familiarity with PureScript.
4
4
5
-
## Getting Started
6
-
7
-
### Do I belong here?
8
-
9
-
Everyone is welcome! People of all experience levels can join, begin contributing, and feel comfortable and safe making mistakes. People of all backgrounds belong here so long as they treat others with dignity and respect and do not harass, belittle, or insult others.
10
-
11
-
### What is the correct way to ask a question?
12
-
13
-
Feel free to ask questions by [opening an issue](https://github.com/purescript-contrib/purescript-argonaut-codecs/issues)! You can also ask questions on the [PureScript Discourse](https://discourse.purescript.org), or on the [Functional Programming Slack](https://functionalprogramming.slack.com) ([join](https://fpchat-invite.herokuapp.com)!) in the `#purescript` and `#purescript-beginners` channels.
14
-
15
-
### I'd like to help, how do I pick something to work on?
16
-
17
-
Any [open issue](https://github.com/purescript-contrib/purescript-argonaut-codecs/issues) that is not assigned to anyone is good to work on! If it's your first time contributing it's probably best to pick an issue marked [good first issue](https://github.com/purescript-contrib/purescript-argonaut-codecs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue). You can also search for issues marked [help-wanted](https://github.com/purescript-contrib/purescript-argonaut-codecs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted).
18
-
19
-
The easiest way you can help is by contributing documentation (issues marked [document me](https://github.com/purescript-contrib/purescript-argonaut-codecs/issues?q=is%3Aissue+is%3Aopen+label%3A%22document+me). If you'd like to contribute documentation, we suggest [reading about the four kinds of documentation](https://documentation.divio.com).
20
-
21
-
Your contribution can be as small as copy-pasting some instructions from an issue into the documentation! Everything is welcome.
22
-
23
-
## Developing argonaut-codecs
24
-
25
-
All `purescript-contrib` libraries use recent versions of [PureScript](https://github.com/purescript/purescript), [Spago](https://github.com/purescript/spago), and [psa](https://github.com/natefaubion/purescript-psa). Any additional development dependencies can be installed via NPM and are listed in the `package.json` file for the repository.
26
-
27
-
### Proposing changes
28
-
29
-
If you would like to contribute code, tests, or documentation, please feel free to open a pull request for small changes. For large changes we recommend you first open an issue to propose your change and ensure that the maintainers are on board before you spend time implementing the change. We want to respect your time and effort. We can also assign the issue to you if you would like to make sure you're the one to work on it.
30
-
31
-
### Merging changes
32
-
33
-
All changes must happen through a pull request. Everyone with commit access can merge changes, though by convention we like to wait for two approvals for non-trivial changes. All pull requests must pass continuous integration; if the change adds new code we may also ask that you add a test.
34
-
35
-
## How do I get the "commit bit"?
36
-
37
-
If you'd like to take part in maintaining argonaut-codecs, just ask! We hand out the commit bit to folks who display sustained interest in the project. You can ask directly (for example: on Slack or via a DM on Discourse) or by opening an issue -- whichever you prefer!
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.
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.
2
3
3
-
Please describe the purpose of the pull request, including any background context and links to related issues. If this introduces a large change to the project, please describe what you have implemented.
4
+
---
4
5
5
-
## Where should the reviewer start?
6
+
**Checklist:**
6
7
7
-
Help save the reviewer time by highlighting the most important sections of code.
8
-
9
-
## How should this be manually tested?
10
-
11
-
If this is a new feature, you should provide new test coverage. If it fixes an existing bug, you should provide a failing test case this change fixes. Other than automated testing, what manual tests can the reviewer perform to verify your work?
12
-
13
-
## Other Notes:
14
-
15
-
Does the project documentation need to be updated? Should we introduce a new example, or update any existing examples? Does this PR require any other follow-up tasks?
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)
stale-issue-message: "This issue is stale because it has been open for ${{ env.days-until-stale }} days with no activity. Remove the stale label or comment to keep this issue open. Otherwise, this issue will be closed in ${{ env.days-until-close }} days."
18
+
stale-pr-message: "This pull request is stale because it has been open for ${{ env.days-until-stale }} days with no activity. Remove the stale label or comment to keep this pull request open. Otherwise, this pull request will be closed in ${{ env.days-until-close }} days."
[Argonaut](https://github.com/purescript-contrib/purescript-argonaut) is a collection of libraries for working with JSON in PureScript. `argonaut-codecs` provides codecs based on the `EncodeJson` and `DecodeJson` type classes, along with instances for common data types and combinators for encoding and decoding `Json` values.
@@ -19,13 +18,13 @@ The quick start will get you up and running with the basics of `argonaut-codecs`
19
18
20
19
## Installation
21
20
22
-
Install with [Spago](https://github.com/purescript/spago):
or install as part of the [Argonaut](https://github.com/purescript-contrib/purescript-argonaut) bundle:
27
+
or install it as part of the [Argonaut](https://github.com/purescript-contrib/purescript-argonaut) bundle:
29
28
30
29
```sh
31
30
spago install argonaut
@@ -71,11 +70,11 @@ Left "An error occurred while decoding a JSON value:\n At object key 'age':\n
71
70
72
71
## Documentation
73
72
74
-
You can find `argonaut-codecs` documentation in a few places:
73
+
`argonaut-codecs` documentation is stored in a few places:
75
74
76
75
1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-argonaut-codecs).
77
-
2.The tutorial and other written documentation is kept in [the docs directory](./docs).
78
-
3.Additional usage examples can be found in [the PureScript Cookbook](https://github.com/JordanMartinez/purescript-cookbook)
76
+
2.Written documentation and [the changelog](./docs/CHANGELOG.md) are kept in [the docs directory](./docs).
77
+
3.Usage examples can be found in [the test suite](./test).
79
78
80
79
If you get stuck, there are several ways to get help:
81
80
@@ -86,7 +85,7 @@ If you get stuck, there are several ways to get help:
86
85
87
86
You can contribute to `argonaut-codecs` in several ways:
88
87
89
-
1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-argonaut-codecs/issues) issue. We'll do our best to work with you to resolve or answer it.
88
+
1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-argonaut-codecs/issues). We'll do our best to work with you to resolve or answer it.
90
89
91
90
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.
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).
0 commit comments