CONTRIBUTING.md

   1 # Contributing Guidelines
   2
   3 ## Pull Requests
   4
   5 For pull requests, it is recommended to create a new feature branch
   6 (e.g., `feat/my-new-feature`) and submit the pull request from that
   7 branch.  If instead you add the commit(s) directly to the `master`
   8 branch in your own repository, then it can be more difficult to get
   9 back in sync if changes are required to the patch.
  10
  11 To have your pull request accepted quickly, please try to follow these
  12 guidelines:
  13
  14 *   Markdown mode contributions should adhere to both the
  15     [GNU Emacs Lisp coding conventions](https://www.gnu.org/software/emacs/manual/html_node/elisp/Coding-Conventions.html) and the
  16     [Major Mode Conventions](https://www.gnu.org/software/emacs/manual/html_node/elisp/Major-Mode-Conventions.html#Major-Mode-Conventions).
  17
  18 *   Test cases are needed for significant changes.  Markdown Mode uses
  19     the `ert` (Emacs Lisp Regression Testing) library.  If you are not
  20     familiar with writing tests, there are hundreds of examples in
  21     `tests/markdown-test.el` that you can use as a starting point for
  22     new tests.
  23
  24 *   You can confirm that your tests pass by either typing `make test`
  25     from the command line or by issuing a GitHub pull request and
  26     letting the Travis CI integration on GitHub run the tests for you.
  27
  28 *   Please be sure to update the documentation at the top of
  29     `markdown-mode.el` and the docstrings for related variables or
  30     functions.
  31
  32 *   If your patch involves changes to the documentation, you can
  33     update the `README.md` file by running the `webpage.sh` script.
  34
  35 *   It's also helpful if you update the `CHANGES.md` file to reflect
  36     the bug you fixed or the feature you added or improved.