Skip to content

Commit

Permalink
docs: remove circle-ci from development guide, update link, and fix t…
Browse files Browse the repository at this point in the history
…ypo. (#2685)
  • Loading branch information
pichlermarc authored Dec 22, 2021
1 parent 89f862b commit 7578e50
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 19 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You will receive the following error :
✖ type must be one of [ci, feat, fix, docs, style, refactor, perf, test, revert, chore] [type-enum]
```

Here an exemple that will pass the verification: `git commit -s -am "chore(opentelemetry-core): update deps"`
Here an example that will pass the verification: `git commit -s -am "chore(opentelemetry-core): update deps"`

### Fork

Expand Down
19 changes: 1 addition & 18 deletions doc/development-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The code base is a monorepo. We use [Lerna](https://lerna.js.org/) for managing
## Requirements

Since this project supports multiple Node versions, using a version
manager such as [nvm](https://github.com/creationix/nvm) is recommended.
manager such as [nvm](https://github.com/nvm-sh/nvm) is recommended.

To get started once you have Node installed, run:

Expand Down Expand Up @@ -51,23 +51,6 @@ To fix the linter, use:
npm run lint:fix
```

## Continuous Integration

We rely on CircleCI 2.0 for our tests. If you want to test how the CI behaves
locally, you can use the CircleCI Command Line Interface as described here:
<https://circleci.com/docs/2.0/local-jobs/>

After installing the `circleci` CLI, simply run one of the following:

```sh
circleci build --job lint
circleci build --job node8
circleci build --job node10
circleci build --job node11
circleci build --job node12
circleci build --job node12-browsers
```

## Docs

We use [typedoc](https://www.npmjs.com/package/typedoc) to generate the api documentation.
Expand Down

0 comments on commit 7578e50

Please sign in to comment.