Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Requests for Comments
Clone this wiki locally
Neurokernel's development makes use of the concept of a Request for Comments (RFC). Developed during the design of the Internet, RFCs serve as a medium for the proposal of major new features or modifications to Neurokernel's architecture and new fly brain (or LPU) models that can be executed by the framework. Once released, discussion regarding an RFC's contents may lead to modification of the ideas proposed; these must be released in a revised RFC. A revised RFC is always assigned a new identifying number by incrementing the number of the most recently released Neurokernel RFC. Authoritative copies of all RFCs are available on the Neurokernel project web site.
While there is currently no explicit prescribed format for Neurokernel RFCs, it is recommended that they be structured similar to a technical design or research proposal. RFCs should be disseminated in PDF or text format. All RFCs must be released under terms of copyright (e.g., the Open Publication License or one of the Creative Commons licenses) that permit public redistribution or be explicitly placed in the public domain.
All RFCs should have a version number with the format X.Y. The initial version number of every RFC should be set to 1.0. If nontrivial changes are made to an RFC, its major version number should be incremented; if minor modifications such as typos or formatting are made, its minor number should be incremented. When an RFC contains significant changes that supersede the contents of an existing RFC, the former may be designated as rendering the latter obsolete. Each unique version of an RFC should also be assigned a DOI via a service such as Zenodo.
If you have written a new RFC, please let the Neurokernel developers know on the project mailing list so that it can be posted online and discussed.