Skip to content

Commit

Permalink
add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xhliu committed Mar 1, 2020
1 parent 625ab92 commit e452eaa
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
19 changes: 19 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributing to sCrypt
Loving sCrypt and want to contribute? Thanks! There are many ways you can help sCrypt and Bitcoin.

Below are guidelines to help you get some ideas on where to start. They aim to making the contribution process straightforward and effective. If you need more ideas on what to contribute, please reach out at [Slack](https://join.slack.com/t/scryptworkspace/shared_invite/enQtNzQ1OTMyNDk1ODU3LTJmYjE5MGNmNDZhYmYxZWM4ZGY2MTczM2NiNTIxYmFhNTVjNjE5MGYwY2UwNDYxMTQyNGU2NmFkNTY5MmI1MWM).

## Repo Descriptions
All repositories are listed at [scrypt-sv](https://github.com/scrypt-sv).

### [testing](https://github.com/scrypt-sv/testing)
This repo provides a testing framework for sCrypt projects. Search for ``TODO``s on what is missing to get started.
### [bsv](https://github.com/scrypt-sv/bsv)
This repo contains a fork of [bsv](https://github.com/moneybutton/bsv) library to specialize in script processing. You can start by merging latest updates from upstream repo. Also existing changes need to be polished and tests fixed.
### [boilerplate](https://github.com/scrypt-sv/boilerplate)
This repo acts as a sCrypt project boilerplate. You can start by adding more contracts and tests.
### [specification](https://github.com/scrypt-sv/specification)
This repo contains the full specification for the sCrypt Language. You can start by proofreading and adding more example contracts.

## License
All contributed code will be open source and licensed under MIT.
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Contact

`Telegram <https://t.me/joinchat/GwaRAxKT16JjXyHt5PuhHw>`_

..
contributing: PR for example contracts
Contributing
------------
See `CONTRIBUTING.md <https://github.com/scrypt-sv/specification/blob/master/docs/CONTRIBUTING.md>`_ for more information on what we're looking for and how to get started.


0 comments on commit e452eaa

Please sign in to comment.