Skip to content

3. Submit your code

Iván Ovejero edited this page Jun 17, 2020 · 9 revisions

Pre-submission checks

  • Check if it builds: npm run build
  • Run all tests: npm run test
  • Check your code against the checklist.
  • Run the linter: cd packages/nodes-base/nodes && npm run tslint

Open pull request against fork

  • Push your branch to our fork: git push origin my-new-integration
  • Open a draft pull request against our fork master. We are not going to merge it to our fork's master, but we can use this for internal team review before pulling against the upstream.
  • Feel free to post your PR in the #needs-review channel for Pod 0.2.1.
  • Once internal review is over, please ask Ricardo to review. Once approved by Ricardo, we squash all commits into a single one and open a PR to the official repo.

Review pull request against fork

  • Get the branch: git fetch
  • Switch to the branch: git checkout my-new-integration
  • Build it: npm run build
  • Run all tests: npm run test
  • Check if the node works in-UI: npm run devlocalhost:8080
  • Go to PR and...
    • Start review → Add in-line comments
    • Review changes → Add overall summary → Comment or Request changes (as appropriate)

Important: Do not merge! This is a draft PR for internal team review only.

Pull request against upstream

  • Open a pull request against n8n/master. Prefix the title with "[WIP]" and in the description mention you're with MLH and explain your creation or fix. See example. Sign the Contributor License Agreement.