avram
Avram
Why Avram?
The name comes from Henriette Avram.
Henriette Davidson Avram (October 7, 1919 – April 22, 2006) was a computer programmer and systems analyst who developed the MARC format (Machine Readable Cataloging), the international data standard for bibliographic and holdings information in libraries.
Installation
Add this to your application's shard.yml
:
dependencies:
avram:
github: luckyframework/avram
Usage
require "avram"
Contributing
- Fork it ( https://github.com/luckyframework/avram/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Install docker and docker-compose: https://docs.docker.com/compose/install/
- Run
script/setup
- Make your changes
- Run
script/test
to run the specs, build shards, and check formatting - Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
Testing
To run the tests:
- Install docker and docker-compose: https://docs.docker.com/compose/install/
- Run
script/setup
to set up the docker environment - Run
script/test
to run the specs, build shards, and check formatting
You can run individual tests like this: docker-compose run --rm app crystal spec path/to/spec.cr
Remember to run
docker-compose down
when you're done. This will stop the Crystal container.
Contributors
- paulcsmith Paul Smith - creator, maintainer
- mikeeus Mikias Abera - contributor