mirror of https://github.com/kdl-org/kdl.git
40 lines
1.6 KiB
Markdown
40 lines
1.6 KiB
Markdown
# Contributing
|
|
|
|
This repository relates to activities in the Internet Engineering Task Force
|
|
([IETF](https://www.ietf.org/)). All material in this repository is considered
|
|
Contributions to the IETF Standards Process, as defined in the intellectual
|
|
property policies of IETF currently designated as
|
|
[BCP 78](https://www.rfc-editor.org/info/bcp78),
|
|
[BCP 79](https://www.rfc-editor.org/info/bcp79) and the
|
|
[IETF Trust Legal Provisions (TLP) Relating to IETF Documents](http://trustee.ietf.org/trust-legal-provisions.html).
|
|
|
|
Any edit, commit, pull request, issue, comment or other change made to this
|
|
repository constitutes Contributions to the IETF Standards Process
|
|
(https://www.ietf.org/).
|
|
|
|
You agree to comply with all applicable IETF policies and procedures, including,
|
|
BCP 78, 79, the TLP, and the TLP rules regarding code components (e.g. being
|
|
subject to a Simplified BSD License) in Contributions.
|
|
|
|
|
|
## Mechanics
|
|
|
|
Contributions can be made by creating pull requests.
|
|
The GitHub interface supports creating pull requests using the Edit (✏) button.
|
|
|
|
|
|
## Building the Specification
|
|
|
|
The specification is written in
|
|
[kramdown-rfc](https://github.com/cabo/kramdown-rfc/wiki/Syntax2), which
|
|
compiles via [RFCXML](https://authors.ietf.org/rfcxml-vocabulary) to text and
|
|
HTML.
|
|
|
|
You can build the formatted versions or the intermediate RFCXML file using
|
|
https://author-tools.ietf.org/ or locally by running `make`. To preserve the
|
|
intermediate RFCXML form in a local build, run `make draft-marchan-kdl2.xml`
|
|
once.
|
|
|
|
Command line usage requires that you have the necessary software installed. See
|
|
[the instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/SETUP.md).
|