flownote
Version:
FlowNote lets developers create, organize, and reason about event-oriented applications with a simple flow-based language.
46 lines (33 loc) • 1.89 kB
Markdown
# Contribution Guidelines
## Community
Chat us up on Gitter! [](https://gitter.im/flownote/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## Testing
Before submitting a Pull Request, run `./flownote test-e2e` to make sure the everything passes.
## Pull Requests
When you're ready to submit pull requests, make sure you create a new branch off of `master`. (The `master` branch is always `next` on NPM)
## Porting
It might be worthwhile to port FlowNote to Python, Go, or Rust. If someone wants to take up that task, here's a list of optional dependencies FlowNote uses.
* [Node v11.12.0](https://nodejs.org/en/blog/release/v11.12.0/): Host language
* [Colors](https://github.com/Marak/colors.js): Cross-terminal coloring tool
* [ESM](https://github.com/standard-things/esm): Easy import/export support
* [Fast Safe Stringify](https://github.com/davidmarkclements/fast-safe-stringify): Fast JSON representation (Event emissions)
* [ClinicJS](https://github.com/nearform/node-clinic): Profiling tool
These dependencies will have to be ported as well.
* [OhmJS](https://github.com/harc/ohm): Parser, lexer, and compiler
* [Flatted](https://github.com/WebReflection/flatted): Safely represents and restores circular JSON (Application snapshots)
* [HyperID](https://github.com/mcollina/hyperid): Fast GUID generation
* [QS](https://github.com/ljharb/qs): Parses complex querystrings (nested objects and arrays) for HTTP GET requests.
##### Documentation
(
[Installation](01-installation.md) |
[Features](02-features.md) |
[Use Cases](03-use-cases.md) |
[Language](04-language.md) |
[Application](05-application.md) |
[Flow](06-flow.md) |
[Nodes](07-nodes.md) |
[Channels](08-channels.md) |
Contribution Overview |
[Roadmap](10-roadmap.md) |
[Known Problems](11-known-problems.md)
)