Contributing

Contributions are welcome!

Development

Clone the repository and you're ready to go — no special requirements.

git clone https://github.com/alex-lairan/monads.git
cd monads
shards install
crystal spec

Workflow

1. Fork it (https://github.com/alex-lairan/monads/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Editing the docs

These docs are built with VitePress from the Markdown files in the docs/ directory. To preview them locally:

npm install
npm run docs:dev

Every push to master rebuilds and redeploys the site to GitHub Pages automatically. Use the Edit this page on GitHub link at the bottom of any page to propose a change quickly.

Contributors

• alex-lairan — Alexandre Lairan, creator & maintainer
• moba1 — moba, maintainer