Skip to content

Commit

Permalink
Directory local bug-reference-url-format; README: new "Contributing"
Browse files Browse the repository at this point in the history
  • Loading branch information
mekeor committed Nov 27, 2024
1 parent aed9716 commit 26ee7e3
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 14 deletions.
5 changes: 5 additions & 0 deletions .dir-locals.el
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
;; -*- no-byte-compile: t; -*-

((nil
(bug-reference-url-format
. "https://github.com/leanprover-community/lean4-mode/issues/%s")))
10 changes: 10 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -181,3 +181,13 @@ use it. If you want to customize this behavior, e.g. if you'd like to
use Emacs' built-in Flymake package instead of Flycheck while keeping
later installed, then customize the ~lsp-diagnostics-provider~ user
option accordingly.

* Contributing

When you contribute an addition or modification of a substantial part
of Lean4-Mode, then you can add a personal copyright like =;;
Copyright (c) 2024 John Doe= to the beginning of the respective files.

You can use Emacs' built-in ~bug-reference-mode~ and
~bug-reference-prog-mode~ to make in this repository to make mentions
of issues like =#123= clickable.
44 changes: 30 additions & 14 deletions lean4-mode.info
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ _Lean-Mode_).
* Installation::
* Usage::
* Configuration::
* Contributing::

-- The Detailed Node Listing --

Expand Down Expand Up @@ -258,7 +259,7 @@ Key Description Command
‘C-c ! p’ Go to previous error ‘flycheck-previous-error’


File: lean4-mode.info, Node: Configuration, Prev: Usage, Up: Top
File: lean4-mode.info, Node: Configuration, Next: Contributing, Prev: Usage, Up: Top

3 Configuration
***************
Expand Down Expand Up @@ -291,23 +292,38 @@ Emacs' built-in Flymake package instead of Flycheck while keeping later
installed, then customize the ‘lsp-diagnostics-provider’ user option
accordingly.


File: lean4-mode.info, Node: Contributing, Prev: Configuration, Up: Top

4 Contributing
**************

When you contribute an addition or modification of a substantial part of
Lean4-Mode, then you can add a personal copyright like ‘;; Copyright (c)
2024 John Doe’ to the beginning of the respective files.

You can use Emacs' built-in ‘bug-reference-mode’ and
‘bug-reference-prog-mode’ to make in this repository to make mentions of
issues like ‘#123’ clickable.



Tag Table:
Node: Top223
Node: Installation1414
Node: Brief and Generic Instructions1657
Node: Detailed and Concrete Instructions2612
Node: Instructions for Source-Based Use-Package3974
Node: Native vc (Emacs 30 or later)4695
Node: Doom-Emacs5484
Node: Straight5910
Node: Usage6410
Node: lsp-mode7856
Node: Flycheck8141
Node: Configuration8690
Node: lsp-mode (1)8856
Node: Flycheck (1)9125
Node: Installation1431
Node: Brief and Generic Instructions1674
Node: Detailed and Concrete Instructions2629
Node: Instructions for Source-Based Use-Package3991
Node: Native vc (Emacs 30 or later)4712
Node: Doom-Emacs5501
Node: Straight5927
Node: Usage6427
Node: lsp-mode7873
Node: Flycheck8158
Node: Configuration8707
Node: lsp-mode (1)8894
Node: Flycheck (1)9163
Node: Contributing9648

End Tag Table

Expand Down
12 changes: 12 additions & 0 deletions lean4-mode.texi
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ known as @emph{Lean-Mode}).
* Installation::
* Usage::
* Configuration::
* Contributing::
@detailmenu
--- The Detailed Node Listing ---
Expand Down Expand Up @@ -296,4 +297,15 @@ use Emacs' built-in Flymake package instead of Flycheck while keeping
later installed, then customize the @code{lsp-diagnostics-provider} user
option accordingly.

@node Contributing
@chapter Contributing

When you contribute an addition or modification of a substantial part
of Lean4-Mode, then you can add a personal copyright like @samp{;;
Copyright (c) 2024 John Doe} to the beginning of the respective files.

You can use Emacs' built-in @code{bug-reference-mode} and
@code{bug-reference-prog-mode} to make in this repository to make mentions
of issues like @samp{#123} clickable.

@bye

0 comments on commit 26ee7e3

Please sign in to comment.