From 32dd1476ac8bd4cfe1b0483899a1f294b8da1f3d Mon Sep 17 00:00:00 2001 From: Lucien Cartier-Tilet Date: Wed, 7 Sep 2022 10:18:37 +0200 Subject: [PATCH] Update CONTRIBUTING and dir variables --- .dir-locals.el | 4 +++- CONTRIBUTING.org | 10 ++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/.dir-locals.el b/.dir-locals.el index 47674e1..53425f3 100644 --- a/.dir-locals.el +++ b/.dir-locals.el @@ -3,4 +3,6 @@ ((emacs-lisp-mode . ((sentence-end-double-space . t) (indent-tabs-mode . nil))) - (makefile-mode . ((indent-tabs-mode . t)))) + (makefile-mode . ((indent-tabs-mode . t))) + (org-mode . ((sentence-end-double-space . nil) + (fill-column . 70)))) diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org index 2e8c6e0..19e7ef9 100644 --- a/CONTRIBUTING.org +++ b/CONTRIBUTING.org @@ -11,6 +11,7 @@ hard to follow them. - [[#how-can-i-contribute][How Can I Contribute?]] - [[#submitting-bugs-and-errors][Submitting Bugs and Errors]] - [[#submitting-new-code][Submitting New Code]] + - [[#ensuring-the-quality-of-your-code][Ensuring the quality of your code]] - [[#git-commit-messages][Git Commit Messages]] - [[#describing-the-pull-request][Describing the Pull Request]] - [[#finding-something-to-do][Finding Something To Do]] @@ -46,6 +47,15 @@ the following: - And obviously, your code works (I include that because I myself sometimes push commits that don’t work) +*** Ensuring the quality of your code +Although a CI is already in place on the Github repository, you are +encouraged to make sure yourself everything runs correctly. + +This package uses [[https://github.com/emacs-eask/eask][Eask]] to run its linters. Once it is installed, you +can go to your preferred terminal and run ~make ci~. If everything goes +well, you’re ready to submit your code to the repository. If not, +please fix whatever Eask complains about first. + *** Git Commit Messages Your commits should also follow [[https://github.com/syl20bnr/spacemacs/blob/develop/CONTRIBUTING.org#commit-messages][Spacemacs’ guidelines]] on this matter, especially: