OptimisticDev/rfcs
2
1
Fork 0
forked from kaboom-standards-organization/rfcs
Code Pull requests Activity

Compare commits

base: OptimisticDev:7bcbe755dbd416ba249daa292e30fe5b29af58d7
Branches Tags
OptimisticDev:main
OptimisticDev:requirements-explanation
kaboom-standards-organization:main
...
compare: OptimisticDev:05d270b34e858b3497b7a79b733092d7a07287a0
Branches Tags
OptimisticDev:requirements-explanation
OptimisticDev:main
kaboom-standards-organization:main

2 commits
7bcbe755db ... 05d270b34e

Author SHA1 Message Date
OptimisticDeving
05d270b34e
RFC 0001: Start work 2024-06-26 04:29:48 +01:00
OptimisticDeving
d667ac0152
RFC 0000: Remove accidental extra character 2024-06-26 03:28:13 +00:00
2 changed files with 24 additions and 1 deletions
Show stats Expand all files Collapse all files

2
rfcs/0000-Genesis_RFC.md
View file

@ -63,7 +63,7 @@ You must not embed images.
### Sentences & Wording
Sentences smust be split with a line break, and you must not split up sentences for a consistent line size.
Sentences must be split with a line break, and you must not split up sentences for a consistent line size.
You can split up a group of sentences about similar ideas into paragraphs with two newlines.
You must only use proper grammar, proper casing, proper casing and proper punctuation.

23
rfcs/0001-Code_Guides.md Normal file
View file

@ -0,0 +1,23 @@
# RFC #0001 - Code Guides
## Preface
This RFC details the targeted scope and formatting of [Guide wiki](https://code.chipmunk.land/kaboom-standards-organization/guide/wiki) pages which guide the reader on utilizing specific protocol/bot libraries.
## Scope
The guides for these libraries must not introduce the reader to the basic concept of programming and the syntax of the programming languages the bot libraries target.
However, as these guides are primarily intended to help get programmers off their feet when starting with a new bot library, it is somewhat likely that it will be the first time someone attempts to program, so things that violate conventional, real-life logic but does not violate programmer/program logic (i.e. indexes starting from 0 instead of 1).
It must attempt to introduce the reader to the peculiarities of the programming language when it is certain that bot development will inevitably run into such peculiarities.
It must also attempt to illustrate unique design choices in the bot libraries it describes.
### Tooling
The guide should attempt to tell the user what programs (IDEs, compilers and IDE extensions) they are recommended to use in relation to the language and bot library, and should also mention some alternatives and the reason why they're not recommended.
#### Examples
A guide about a library for Javascript would recommend that the user should install Visual Studio Code and use the npm package manager but also mention that yarn exists.
A guide about a library for Rust would recommend that the user should install Visual Studio Code, install Rust with rustup, use the cargo package manager, use the rust-analyzer extension but also mention that JetBrains provide RustRover.
A guide about a library for Java would recommend that the user should install IntelliJ Idea, install the JDK through IntelliJ and use Gradle for compilation but also mention that Eclipse and Maven exist.