Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 2.23 KB

Contributing to Fable

We love pull requests from everyone. By participating in this project, you agree to abide by the thoughtbot code of conduct.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code ( no patch is too small : fix typos, add comments, clean up inconsistent whitespace )
  • by refactoring code
  • by closing issues
  • by reviewing patches

Development

  • In order to run the library, you will need to install Kafka
    • On Macs you can install it using brew: brew install kafka
    • brew services start kafka
    • Zookeeper is a Kafka manager that installs with Kafka. Run it with brew services start zookeeper
  • In order to run tests, run sbt test. Sbt is the Scala Build Tool. On Macs you can install it via brew install sbt

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your Fable version, Scala version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

  1. Fork the official repository.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add, commit, and push your changes.
  5. Submit a pull request.

Notes

  • Please add tests if you changed code. Contributions without tests won't be accepted.
  • Please don't update the version.

Inspired by https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md