Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove circle-ci from development guide, update link, and fix typo. #2685

Merged
merged 3 commits into from
Dec 22, 2021
Merged

docs: remove circle-ci from development guide, update link, and fix typo. #2685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c528d8
docs: remove mentions of circle-ci.
pichlermarc Dec 22, 2021
c02ca98
docs: fix typo in contributing file.
pichlermarc Dec 22, 2021
8144a11
docs: update link to nvm in development guide.
pichlermarc Dec 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
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
View file
Open in desktop
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