Contribution Guidelines

Community

Chat us up on Gitter!

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: Host language
• Colors: Cross-terminal coloring tool
• ESM: Easy import/export support
• Fast Safe Stringify: Fast JSON representation (Event emissions)
• ClinicJS: Profiling tool

These dependencies will have to be ported as well.

• OhmJS: Parser, lexer, and compiler
• Flatted: Safely represents and restores circular JSON (Application snapshots)
• HyperID: Fast GUID generation
• QS: Parses complex querystrings (nested objects and arrays) for HTTP GET requests.

Documentation

( Installation | Features | Use Cases | Language | Application | Flow | Nodes | Channels | Contribution Overview | Roadmap | Known Problems )