Contributing Guide

NOTE TO FUTURE CONTRIBUTORS: I plan to merge this package into GNU Elpa or Org source at some point.

So you will need to assign your copyright to FSF in order to get your patches accepted.

As a bonus, once you have assigned your copyright to FSF, doors open up for your future contributions to Emacs too!

Contribute to documentation #

Minimum required Hugo version: 0.48

  1. Clone this repo.
  2. Add/edit documentation to doc/ox-hugo-manual.org.
  3. Run make doc.
    • This generates the Markdown files for the ox-hugo documentation site and the .org files like README.org and CONTRIBUTING.org for GitHub.
  4. Review the changes in the generated .org and .md files.
  5. Commit only the .org files, push branch and create PR.
    • The .org.md conversion is done by ox-hugo on Netlify.

Contribute to code #

While the end-user does not need Pandoc installed on their machine, a code contributor needs to have both pandoc and pandoc-citeproc installed1.

These are needed for make md and make -j1 test steps to work as they use/test the Pandoc Citations feature too.

Minimum required Hugo version: 0.48

  1. Clone this repo.
  2. Add/edit the .el files, tests in test/site/content-org/, and documentation to doc/ox-hugo-manual.org.
  3. Run make md doc.
  4. Review the changes in the generated .org and .md files.
    • Ignore the changes shown in git diff related to only the randomly generated Org ID’s (like org17de7a9).
  5. Commit (don’t push your branch yet!).
    • As mentioned above, commit only the .org files for documentation.
  6. Run test: make -j1 test (you need to git commit i.e. do the above step before this step).
  7. Fix your commit(s) if the test fails.. repeat till you succeed.
  8. Push your feature branch and create PR.

  1. The Pandoc Citations feature was last <2018-08-19 Sun> tested with Pandoc version 2.2.2. If you are running an older version, the quickest way to install might be to simply download the latest release archive from Pandoc releases, extract it and put the pandoc and pandoc-citeproc binaries in one of the directories in your PATH. [return]
Fork me on GitHub