commit d05676a354f253f84e8e9d2d4732c0a594deb00a parent 9453f2303e1805749b326d9e47008b3dc381e54e Author: Iqbal Ansari <iqbalansari02@yahoo.com> Date: Wed, 16 Mar 2016 22:37:19 +0530 Add contributing instructions Diffstat:
| M | README.org | | | 22 | ++++++++++++++++++++++ |
1 file changed, 22 insertions(+), 0 deletions(-)
diff --git a/README.org b/README.org @@ -18,6 +18,7 @@ - [[#controlling-behaviour-when-point-enters-an-emoji][Controlling behaviour when point enters an emoji]] - [[#controlling-behaviour-when-mouse-hovers-over-an-emoji][Controlling behaviour when mouse hovers over an emoji]] - [[#known-issues][Known issues]] + - [[#contributing][Contributing]] - [[#thanks][Thanks]] - [[#credits][Credits]] - [[#licence][Licence]] @@ -179,6 +180,27 @@ loaded. - There is currently no support for custom emojis/images. I plan to add this in future. +** Contributing + Code as well as documentation contributions are welcome. Development on + Emojify happens only on *develop* branch with stable and well-tested changes + merged from time to time into ~master~ as such make sure you base your + changes and pull requests on the *develop* branch. + + [[https://github.com/cask/cask][Cask]] is used to manage project dependencies so make sure you have it + installed. To run the tests you need to install the dependencies by running + the following + + #+BEGIN_SRC sh + cask install + #+END_SRC + + After the installation completes you can run the tests by running the + following command + + #+BEGIN_SRC sh + cask exec ert-runner + #+END_SRC + ** Thanks Special thanks to @ryanprior for bug reports and valuable feedback on the issue tracker.