Compare commits
3 Commits
Author | SHA1 | Date |
---|---|---|
Lucien Cartier-Tilet | ac9e3e4c17 | |
Lucien Cartier-Tilet | 579b901de2 | |
Lucien Cartier-Tilet | f55f25b989 |
|
@ -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))))
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
|
||||
;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
|
||||
;; Version: 0.4.0
|
||||
;; Version: 0.4.1
|
||||
;; Package-Requires: ((emacs "25.1") (org "9.3"))
|
||||
;; Homepage: https://labs.phundrak.com/phundrak/org-unique-id
|
||||
;; Keywords: convenience
|
||||
|
@ -26,17 +26,52 @@
|
|||
|
||||
;;; Commentary:
|
||||
|
||||
;; This package is inspired by a blog post I published about a year
|
||||
;; before I decided to write this package [1], which in turn is
|
||||
;; largely inspired by another blog post [2].
|
||||
;; org-unique-id is a utility package for org-mode users that are
|
||||
;; tired dealing with random org IDs for their headers’ anchor that
|
||||
;; change on each org to HTML exports among others. This package
|
||||
;; creates meaningful custom IDs for org headers that won’t change
|
||||
;; unless the user modifies or removes them manually.
|
||||
;;
|
||||
;; It will generate a unique ID for each headers in an org file based
|
||||
;; on the headers’ name plus a random short string in order to be sure
|
||||
;; to make it unique. This ID will be inserted in each header’s
|
||||
;; properties as a custom ID.
|
||||
;; In order to be enabled, this package’s `org-unique-id-maybe'
|
||||
;; function must be hooked to `before-save-hook', and the string
|
||||
;; \\='auto-id:t\\=' must be present in an \\='#+OPTIONS:\\=' line in
|
||||
;; the buffer.
|
||||
;;
|
||||
;; [1] https://blog.phundrak.com/better-custom-ids-orgmode/
|
||||
;; [2] https://writequit.org/articles/emacs-org-mode-generate-ids.html
|
||||
;; If the \\='auto-id:t\\=' string is found, then it will create a
|
||||
;; slug of the current header (and if there are, its parent headers)
|
||||
;; and it will add a unique string suffix generated with a UUID
|
||||
;; generator to ensure all IDs are unique.
|
||||
;;
|
||||
;; Here is an example of an org-mode file without the
|
||||
;; \\='auto-id:t\\=' option after save:
|
||||
;;
|
||||
;; #+title: Test file
|
||||
;; * Test level 1
|
||||
;; ** Test level 2
|
||||
;; * Test level 1
|
||||
;;
|
||||
;; And here is the same org-mode file but with the option atop its
|
||||
;; content:
|
||||
;;
|
||||
;; ,#+title: Test file
|
||||
;; ,#+options: unique-id:t
|
||||
;; ,* Test level 1
|
||||
;; :PROPERTIES:
|
||||
;; :CUSTOM_ID: Test-level-1-zmb40t305kj0
|
||||
;; :END:
|
||||
;; ,** Test level 2
|
||||
;; :PROPERTIES:
|
||||
;; :CUSTOM_ID: Test-level-1-Test-level-2-spn40t305kj0
|
||||
;; :END:
|
||||
;; ,* Test level 1
|
||||
;; :PROPERTIES:
|
||||
;; :CUSTOM_ID: Test-level-1-1nx40t305kj0
|
||||
;; :END:
|
||||
;;
|
||||
;; Of course the last part of the custom ID might differ for you, but
|
||||
;; once it is generated, org-unique-id will not modify it or
|
||||
;; regenerate it unless you delete it yourself, hence ensuring a
|
||||
;; constant ID for your org exports.
|
||||
|
||||
;;; Code:
|
||||
|
||||
|
|
Loading…
Reference in New Issue