docs: Use Eask for contributing

This commit is contained in:
JenChieh
2023-04-22 13:20:24 -07:00
parent 72ddbec953
commit 586d957650
2 changed files with 5 additions and 1093 deletions

View File

@@ -77,16 +77,18 @@ and the [tips and
conventions](https://www.gnu.org/software/emacs/manual/html_node/elisp/Tips.html) conventions](https://www.gnu.org/software/emacs/manual/html_node/elisp/Tips.html)
from the Emacs manual. from the Emacs manual.
You should also check for errors and linter warnings in your code. You can do so in Emacs with flymake or flycheck, but we recommend running the tool `makem.sh` provided with the repository: You should also check for errors and linter warnings in your code. You can do so in Emacs with flymake or flycheck, but we recommend running the tool `Eask` provided with the repository:
This assumes you have [Eask](https://github.com/emacs-eask/cli) installed.
```sh ```sh
./makem.sh lint-compile eask compile
``` ```
This program will tell you if there is any problem with your code. If there's no output, everything is fine. You can run all tests like so, but note it might give you spelling errors that aren't relevant in this project: This program will tell you if there is any problem with your code. If there's no output, everything is fine. You can run all tests like so, but note it might give you spelling errors that aren't relevant in this project:
```sh ```sh
./makem.sh all eask lint checkdoc && eask lint package
``` ```
## How to install ## How to install

1090
makem.sh

File diff suppressed because it is too large Load Diff