Skip to content

Latest commit

 

History

History
103 lines (62 loc) · 6.53 KB

CONTRIBUTING.md

File metadata and controls

103 lines (62 loc) · 6.53 KB
Raw

Contributing to commercetools nodejs

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Submitting a Pull Request

Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first if somebody else is already working on this or the core developers think your feature is in-scope for the related package / project. Generally always have a related issue with discussions for whatever you are including.

Please also provide a test plan, i.e. specify how you verified that your addition works.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Setting Up a Local Copy

  1. Clone the repo with git clone [email protected]:commercetools/nodejs.git

  2. Run yarn install (or yarn) in the root nodejs folder. This will ensure that all package dependencies are properly installed / linked. The repository uses lerna to orchestrate the different packages.

  3. If you're writing documentation, you can start the gitbook development server with yarn docs:watch

  4. To run all packages tests simply do yarn test (we use jest). If you want to work on a specific package and run the tests only for that package, we recommend to use yarn test:package. This will prompt you to select one of the available packages. To run in watch mode simply do yarn test:package --watch.

  5. Integration tests are separated out in another folder "/integration-tests". To run the integration test, you need to export the environment variables into the process env by doing the following :-

    • Export npm_config_projectkey = projectKey,
    • Export CT_PROJECT_KEY=CLIENT_ID:CLIENT_SECRET as specified here.
    • Then run integration test with yarn test:integration

Note: Due to the setup/teardown nature of the integration tests, there is the risk of potential data loss in your project

  1. Linting and static checks are done by yarn lint. We the Airbnb eslint config. Static checks are done using Flow and can be included / adopted incrementally. Committing also runs a git hook to lint the changed files.

Formatting (Prettier)

We use prettier to format our code, so we don't ever have to argue over code-style.

Prettier is integrated into ESLint, so all code is checked. The rules are only enabled when running yarn lint from the command-line. The rules are disabled in Atom so we don't get the annoying warnings while developing.

Setup

Since prettier is integrated into ESLint it should run for the exact same files that are being linted. We run prettier as part of ESLint using eslint-plugin-prettier. We disable all rules that prettier takes care of using eslint-config-prettier.

Upgrading dependencies

We use Renovate to get notified whenever there is a new version of a dependency, in form of a Pull Request. It's recommended to check the changes of the new versions before merging the PR. If necessary the PR should be updated with necessary code changes / migrations.

Update yarn.lock file

To ensure the lock file is up-to-date with the new versions, it's recommended to do checkout the branch, install the new deps with yarn and push the updated lock file to the PR.

Releases

We use lerna to manage our multi-package (monorepo) repository and we use changesets to publish packages to npm, the following steps will allow you to add a changeset to a change you wish to publish

  • Run the command yarn changeset, a list of packages will be listed.
  • Select the package(s) that include the changes.
  • Add the packages you wish to publish to npm
  • Commit the changes, push to Github and then create a PR

When this PR is merged into the base branch, a new release PR will be created by changeset and this PR is repsonsible for the actual package release.

Commit message

Make sure your commit messages follow Angular's commit message format. To make this easy run yarn commit from the root.

    docs(contributing): add example of a full commit message

    The example commit message in the contributing.md document is not a concrete example. This is a problem because the
    contributor is left to imagine what the commit message should look like based on a description rather than an example. Fix the
    problem by making the example concrete and imperative.

    Closes #1
    BREAKING CHANGE: imagination no longer works

Semver version triggers

Based on the semantic release conventions, there are 3 triggers to control the semver version plus a trigger for releasing the actual packages.

Merging Pull Requests

To avoid possible mistakes in the commit messages, and ensure that merging PRs will lead to releasing new versions, there is only one way to merge the PR: by Squash and Commit. This is the perfect opportunity to ensure to adjust the commit message description following the semantic release conventions. This means that commits done while developing the PR don't necessary need to include the release triggers. You can simply do that when squashing the "final" commit.

Many thanks to h5bp and create-react-app for the inspiration with this contributing guide