Skip to content

Conversation

@jverce
Copy link
Contributor

@jverce jverce commented Sep 14, 2021

Description

This is the first of a series of PR's that document the guidelines
to follow during a code review. It covers the following sections:

  1. Preliminary steps
  2. Sensible definition of props
  3. Good code structure
  4. Good 3rd party API usage

Code Changes

  • Add new docs section for PR review guidelines
  • Include VuePress config file in the linting process
  • Include line numbers to code blocks in the docs
  • Update dependencies

* Add new docs section for PR review guidelines
* Include VuePress config file in the linting process
* Include line numbers to code blocks in the docs
* Update dependencies
@jverce jverce added the docs label Sep 14, 2021
@jverce jverce requested a review from dylburger September 14, 2021 16:59
@jverce jverce self-assigned this Sep 14, 2021
@vercel
Copy link

vercel bot commented Sep 14, 2021

@jverce is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link

vercel bot commented Sep 14, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

pipedream-docs-redirect-do-not-edit – ./docs

🔍 Inspect: https://vercel.com/pipedreamers/pipedream-docs-redirect-do-not-edit/3AheWweZZfgq3Ftv57i4khzkm3n7
✅ Preview: https://pipedream-docs-redirect-do-not-edit-git-for-4276ab-pipedreamers.vercel.app

Copy link
Contributor

@dylburger dylburger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jverce mostly small changes

js07 added a commit to js07/pipedream that referenced this pull request Mar 28, 2022
Added docs for Common Files and Pagination are taken from [this
PR](PipedreamHQ#1693) by jverce
js07 added a commit that referenced this pull request Mar 31, 2022
* Add missing conventions & examples to Component Guidelines docs

Added docs for Common Files and Pagination are taken from [this
PR](#1693) by jverce

* Add "getters" to .wordlist.txt

* docs: Add guidelines for action name (omit article)

* Formatting - surround package.json in backticks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants