Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export project type #11

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add a note about Testing Framework and workflow
  • Loading branch information
ManasJayanth committed Dec 2, 2020
commit a9f6da237f133e0a42f1b0eab006b2cbbee63afc
8 changes: 7 additions & 1 deletion README.org
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,16 @@
** Contributing guidelines

Currently beta quality. Looking forward to ideas and feedback. If
you're raising a PR, please add a test. Not having types to catch
you're raising a PR, please add a test. (Please see [[** Testing Framework]] Not having types to catch
your errors are hard - even if lisp somehow makes it bearable,
let's ensure we still try to catch errors early!

** Testing Framework

This project uses [[https://www.gnu.org/software/emacs/manual/html_node/ert/Running-Tests-Interactively.html#Running-Tests-Interactively][ERT]] for unit tests and some end-to-end
tests. Testing during development can be convenient with ERT's
interactive mode - =M-x ert=.

** License

MIT licensed. Please see LICENSE for more details