sharded.cr (Example)

sharded.cr is a Github Template for new Crystal Shards.

While a shard can be initialized with crystal init lib lib_name, this shard template ships with extra goodies that make it faster to get the shard published.

This template ships with:

• ameba for style linting
• Github action for Continuous Integration
• Github action to automatically deploy crystal docs to the gh-pages branch
• Habitat for configuration management
• Spectator for testing
• script/setup for easy setup

How to use

1. Create a New Shard
2. Begin coding shard functionality right away; initial configuration and some issues to guide will be automatically created.

Template Development and Contributing

1. gh repo clone grepsedawk/sharded.cr
2. gh repo create TESTREPONAME (I tend to use tmp since I delete this soon after) In the installation, make sure to add a remote (again, I use tmp) so you can push tests later on
3. If you used tmp, make commits to main then do git push tmp main -f. Else, replace your branch name in for tmp here.
4. Check results in example branch, retry if needed, a common workflow while testing for me is git add . && git commit --amend --no-edit && git push tmp main -f
5. When you're ready to make a PR, git checkout -b new-branch-name then gh pr create and follow the prompts