Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

43 lines (35 loc) · 1.4 KB
Raw

How to Contribute

  1. Fork the project & clone locally

  2. Create an upstream remote and sync your local copy before you branch

    git remote add upstream git@github.com:HubSpotWebTeam/hs-node-api.git

  3. Create a .env file in the root of your folder for all process.env tokens, such as the HAPIkey. e.g.

    E2E_TESTS_HAPI_KEY="your-hapi-key"
E2E_TESTS_BLOG_ID="1234567"
E2E_TESTS_WORKFLOW_ID="9876542"
E2E_TESTS_CONTACT_EMAIL="coolrobot@hubspot.com"
E2E_TESTS_CONTACT_ID="1234"
E2E_TESTS_HUBDB_TABLE_ID="999999"
E2E_TESTS_HUBDB_PORTAL_ID="111111"
E2E_TESTS_LAYOUT_ID="1234567785"
E2E_TESTS_LAYOUT_VERSION_ID="1234567894"
E2E_TESTS_PAGE_ID="1234567"
E2E_TESTS_TEMPLATE_PATH="generated_layouts/1234567.html"
E2E_TESTS_EMAIL_ID=""

  4. Create a new branch for each separate piece of work following the convention contribution_type/some-detail e.g. improvement/update-contribution-docs

  5. Make your changes & ensure tests are passing

    npm run build && npm test

  6. Create a new PR in GitHub and within the body notify one of the repo maintainers

PR Process

The current process:

  1. Open PR: master <- feature/my_awesome_branch
  2. PR approved & merged into master
  3. Maintainers merge master into release
  4. Bump version number in release branch
  5. Build & Publish to npm
  6. Merge release back into master (with version bump)