mirror of
https://github.com/gchq/CyberChef.git
synced 2024-11-16 08:58:30 +01:00
38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
Take a look through the [Wiki pages](https://github.com/gchq/CyberChef/wiki) for guides on [compiling CyberChef](https://github.com/gchq/CyberChef/wiki/Getting-started) and [adding new operations](https://github.com/gchq/CyberChef/wiki/Adding-a-new-operation).
|
||
|
|
|
||
|
|
There are lots of opportunities to contribute to CyberChef. If you want ideas, take a look at any [Issues](https://github.com/gchq/CyberChef/issues) tagged with '[help wanted](https://github.com/gchq/CyberChef/labels/help%20wanted)'.
|
||
|
|
|
||
|
|
Before your contributions can be accepted, you must:
|
||
|
|
|
||
|
|
- Sign the [GCHQ Contributor Licence Agreement](https://github.com/gchq/Gaffer/wiki/GCHQ-OSS-Contributor-License-Agreement-V1.0)
|
||
|
|
- Push your changes to your fork.
|
||
|
|
- Submit a pull request.
|
||
|
|
|
||
|
|
|
||
|
|
## Coding conventions
|
||
|
|
|
||
|
|
* Indentation: Each block should consist of 4 spaces
|
||
|
|
* Object/namespace identifiers: CamelCase
|
||
|
|
* Function/variable names: camelCase
|
||
|
|
* Constants: UNDERSCORE_UPPER_CASE
|
||
|
|
* Source code encoding: UTF-8 (without BOM)
|
||
|
|
* All source files must end with a newline
|
||
|
|
* Line endings: UNIX style (\n)
|
||
|
|
|
||
|
|
|
||
|
|
## Design Principals
|
||
|
|
|
||
|
|
1. If at all possible, all operations and features should be client-side and not rely on connections to an external server. This increases the utility of CyberChef on closed networks and in virtual machines that are not connected to the Internet. Calls to external APIs may be accepted if there is no other option, but not for critical components.
|
||
|
|
2. Latency should be kept to a minimum to enhance the user experience. This means that all operation code should sit on the client, rather than being loaded dynamically from a server.
|
||
|
|
3. Use Vanilla JS if at all possible to reduce the number of libraries required and relied upon. Frameworks like jQuery, although included, should not be used unless absolutely necessary.
|
||
|
|
4. Minimise the use of large libraries, especially for niche operations that won't be used very often - these will be downloaded by everyone using the app, whether they use that operation or not (due to principal 2).
|
||
|
|
|
||
|
|
|
||
|
|
With these principals in mind, any changes or additions to CyberChef should keep it:
|
||
|
|
|
||
|
|
- Standalone
|
||
|
|
- Efficient
|
||
|
|
- As small as possible
|