git.iko.soy/rowtype-yoga/purescript-vault
on master help sign in
rowtype-yoga/purescript-vault/CONTRIBUTING.md
50 lines 3.2 kB history raw
1Contributing
2============
4Welcome, and thanks for your interest in Vault. 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.
6Asking questions
7----------------
8If you have a question, please [open an issue](https://github.com/rowtype-yoga/purescript-vault/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.
10Reporting bugs
11--------------
12Please [open an issue](https://github.com/rowtype-yoga/purescript-vault/issues/new?labels=bug&template=bug-report.md) to discuss any defects you find.
14Enhancements
15------------
16Please [open an issue](https://github.com/rowtype-yoga/purescript-vault/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 [vault](https://hackage.haskell.org/package/vault) package as described in [this blog post](https://apfelmus.nfshost.com/blog/2011/09/04-vault.html).
18Improving documentation
19-----------------------
20Please share any suggestions for improving or adding to the documentation by [submitting a pull request](https://github.com/rowtype-yoga/purescript-vault/compare) or [opening an issue](https://github.com/rowtype-yoga/purescript-vault/issues/new?labels=documentation).
22Sharing resources
23-----------------
24If you have created a tutorial, auxiliary library, interesting code example, or other resource related to Vault, please [share it with the PureScript community](https://discourse.purescript.org). Increasing awareness will bring more users (and potential contributors) to the project.
26Submitting code
27---------------
28Pull requests are welcome, but we ask that you [open an issue](https://github.com/rowtype-yoga/purescript-vault/issues/new) to discuss your plans before making any significant investment of your valuable time.
30### Development environment
32You 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.
34### Making changes
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.
39### Preparing your submission
41Please verify your changes before submitting a pull request using the following commands:
421. `purs-tidy check src test`, which ensures that modules in the `src` and `test` directories conform to the project's formatting standards; and
431. `spago -x test.dhall test`, which runs the unit tests.
45### Submitting a pull request
47When you are ready to [submit a pull request](https://github.com/rowtype-yoga/purescript-vault/compare), please make sure to include:
481. a brief description of the change;
491. a link to the related issue, if applicable; and
501. any design considerations you feel are important.