Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 917 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 917 Bytes
Raw

Contributing

Thank you for the interest in the project!

If you found a bug, have a feature request or need help (ask questions) open a new issue.

If you implemented a bugfix, a new feature, or updated the docs/tests feel free to Submit a Pull Request so it can be reviewed and hopefully merged.

Submit a Pull Request

  1. Fork the repository
  2. Install the dependencies & run locally
    • shards install
    • crystal run src/server.cr
  3. Create your feature branch
    • git checkout -b my-new-feature
  4. Work on your fix/feature
    • Add tests to avoid regressions in the future
  5. Run the tests
    • KEMAL_ENV=test crystal spec
    • SAFELIST="fdo.cr github.com" KEMAL_ENV=test crystal spec
  6. Commit your changes
    • git commit -am 'Added some feature'
  7. Push to the branch
    • git push origin my-new-feature
  8. Create new Pull Request