mirror of
https://gitlab.com/embeddable-common-lisp/ecl.git
synced 2026-01-25 05:51:55 -08:00
new-doc: add preliminary contributing guide
Mostly empty now
This commit is contained in:
parent
8c28bd5130
commit
619e31a8c3
2 changed files with 42 additions and 1 deletions
40
src/doc/new-doc/developer-guide/contributing.txi
Normal file
40
src/doc/new-doc/developer-guide/contributing.txi
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
@node Contributing
|
||||
@section Contributing
|
||||
|
||||
@menu
|
||||
* Documentation:: Documentation conventions
|
||||
@end menu
|
||||
|
||||
@node Documentation
|
||||
@subsection Documentation
|
||||
|
||||
How to define functions:
|
||||
|
||||
@verbatim
|
||||
@[sub*]heading @code{ext:run-program} – Short description
|
||||
@lspindex ext:run-program
|
||||
@defun ext:run-program ...
|
||||
|
||||
@table @var
|
||||
@item arg-1
|
||||
description
|
||||
@item arg-2
|
||||
description
|
||||
@item returns
|
||||
One value? More?
|
||||
@end table
|
||||
|
||||
@strong{Description}
|
||||
Description here
|
||||
|
||||
@strong{Examples}
|
||||
|
||||
Example one
|
||||
@exindex @code{ext:run-program} sample run
|
||||
@lisp
|
||||
(ext:run-program "ls")
|
||||
@end lisp
|
||||
|
||||
@end defun
|
||||
|
||||
@end verbatim
|
||||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
@menu
|
||||
@c * Sources structure:: Overview of the source code structure
|
||||
@c * Contributing:: Code, documentation and tests standards
|
||||
* Contributing:: Code, documentation and tests standards
|
||||
@c * Modules hierarchy::
|
||||
@c * Testing and benchmarking::
|
||||
* Manipulating Lisp objects::
|
||||
|
|
@ -15,5 +15,6 @@
|
|||
@c * Current roadmap::
|
||||
@end menu
|
||||
|
||||
@include developer-guide/contributing.txi
|
||||
@include developer-guide/objects.txi
|
||||
@include developer-guide/environment.txi
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue