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.

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

Upgrade dependencies #390

Merged
merged 4 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 12 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,23 @@ Below are a few guidelines we would like you to follow.
If you need help, please reach out to us by opening an issue.

## Report a bug

Reporting bugs is one of the best ways to contribute. Before creating a bug report, please check that an [issue](/issues) reporting the same problem does not already exist. If there is such an issue, you may add your information as a comment.

To report a new bug you should open an issue that summarizes the bug and set the label to "bug".

If you want to provide a fix along with your bug report: That is great! In this case please send us a pull request as described in section [Contribute Code](#contribute-code).

## Suggest a feature

To request a new feature you should open an [issue](../../issues/new) and summarize the desired functionality and its use case. Set the issue label to "feature".

## Contribute code

This is an outline of what the workflow for code contributions looks like

- Check the list of open [issues](../../issues). Either assign an existing issue to yourself, or
create a new one that you would like work on and discuss your ideas and use cases.
create a new one that you would like work on and discuss your ideas and use cases.

It is always best to discuss your plans beforehand, to ensure that your contribution is in line with our goals.

Expand Down Expand Up @@ -53,34 +56,34 @@ To get the code base, have [git](https://git-scm.com/downloads) installed and ru

```sh
$ git clone [email protected]:stateful/vscode-telemetry.git
$ cd vscode-telemetry
```

then ensure to install all project dependencies:

```sh
$ cd vscode-telemetry
```sh {"name":"setup"}
$ npm install
```

### Build Project

To compile all TypeScript files, run:

```sh
```sh {"name":"build"}
$ npm run build
```

In order to automatically re-compile the files when files change, you can use the watch command:

```sh
```sh {"name":"watch"}
$ npm run watch
```

### Test Project

To test the project, run:

```sh
```sh {"name":"test"}
$ npm run test
```

Expand All @@ -89,14 +92,16 @@ $ npm run test
The type definitions for this package are automatically generated from the OpenAPI specs in `/apis` as `/build/index.d.ts`. We use a [node script](https://github.com/stateful/vscode-telemetry/blob/main/scripts/generate-typings.js) to automate this when you build the project.

### Commit messages

Your commit messages ideally can answer two questions: what changed and why. The subject line should feature the “what” and the body of the commit should describe the “why”.

When creating a pull request, its description should reference the corresponding issue id.

### Sign your work / Developer certificate of origin

All contributions (including pull requests) must agree to the Developer Certificate of Origin (DCO) version 1.1. This is exactly the same one created and used by the Linux kernel developers and posted on http://developercertificate.org/. This is a developer's certification that he or she has the right to submit the patch for inclusion into the project. Simply submitting a contribution implies this agreement, however, please include a "Signed-off-by" tag in every patch (this tag is a conventional way to confirm that you agree to the DCO) - you can automate this with a [Git hook](https://stackoverflow.com/questions/15015894/git-add-signed-off-by-line-using-format-signoff-not-working)

```
```sh
git commit -s -m "adding X to change Y"
```

Expand Down
Loading
Loading