mirror/becarpenter-book6
1
0
Fork 0
mirror of https://github.com/becarpenter/book6.git synced 2024-05-07 02:54:53 +00:00
Code Releases Activity

Suggest separate .md files per section

Browse Source
This commit is contained in:
Brian E Carpenter
2022-08-30 08:43:26 +12:00
committed by GitHub
parent 6ea78936e3
commit bc55ba5b8b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -5,13 +5,13 @@ This is a first draft of how to contribute.
Contributors will be self-declared practitioners of IPv6. There is no other entry ticket except a valid GitHub account.
Contributions (in markdown format) will fit into an agreed table of contents. They will be factual and will teach technical readers about a particular aspect of IPv6. As far as possible, references will be to RFCs and other freely available documents.
Contributions (in markdown format, .md files) will fit into an agreed table of contents. They will be factual and will teach technical readers about a particular aspect of IPv6. As far as possible, references will be to RFCs and other freely available documents.
Where there are alternatives and choices for people deploying or using IPv6, the choices will be presented objectively, if possible with factual pros and cons. Justified recommendations may be be made (e.g., "X is generally more secure than Y") but strong personal opinions (e.g., "NAT66 is never the right answer") should be avoided.
Contributors may edit their own and other contributions. However, significant changes should first be discussed using the issue tracker. That isn't necessary for spelling mistakes, grammar problems, or small nits. GitHub PRs will be used when necessary (i.e., where the changes need review). The goal is to achieve IETF-style rough consensus on the content. A typical tie-breaker argument is "I have deployed this and it works well."
Preferably, a contribution will be a complete section. There will be a naming convention for files, based on the table of contents, so that some clever person can write a script to generate the whole book from the repo.
Preferably, a contribution will be a complete section. There will be a naming convention for files, based on the table of contents, so that some clever person can write a script to generate the whole book from the repo. Please add new sections as separate .md files in the folder for each chapter.
Note that contributions MUST be original writing unless the contributor has the legal right to submit the material under the agreed license (see [LICENSE.md](LICENSE.md)).
@ -23,6 +23,6 @@ ASCII art
~~~
for simple stuff).
The language is English, preferably US spelling.
The language is English, preferably US spelling. Please avoid long, complicated sentences and unusual words, because many readers may know English as a second language.
TBD: What about translation into other languages?