Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

61 lines (47 loc) · 1.78 KB
Raw

Eclim Contribution Guide

The project is under active development and we are always looking for assistance.

Quick Guide

  1. Fork eclim

  2. Install Cask.

  3. Create a topic branch: git checkout -b my_branch

  4. Make your changes and update the History.txt file

  5. Write ERT tests, or Buttercup specification tests that exercize the functionality in your changes.

  6. Ensure that your changes pass the lint tests and compile properly:

    make init
make lint
make compile

  7. Ensure that your changes do not break any tests:

    make test
make specs

    All tests must pass.

  8. Push to your branch: git push origin my_branch

  9. Rebase and squash commits

  10. Issue a pull-request for your topic branch

Continuous Integration

This package uses Travis CI and coveralls.io to ensure that new submissions do not break the package and adequate testing is present.

Travis CI

Travis-CI ensures that new submissions pass the Lint tests and compile without any errors. The build badge on this repository's home page gives the current status of the build. Travis-CI is used to build this package on the following versions of Emacs:

  • 24.5
  • 25.1
  • emacs-git-snapshot-travis: which comes from EVM

For more information see .travis.yml.

Coveralls.io

Coveralls.io ensures that the tests are performing adequate code coverage. The coverage badge on this repository's home page gives the current status in terms of a percentage. New commits to this repository should not make this number decrease.