Skip to content
Open
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
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing

## Prerequisites

* [Git](https://git-scm.com/)
* [Node.js](https://nodejs.org/)

## Getting Started

Clone the repository and install dependencies:

```sh
git clone https://github.com/CodeZombieCH/vscode-gitignore.git
cd vscode-gitignore
npm i
```

## Debugging

To debug the extension, run the following command to compile and watch for changes:

```
npm run watch
```

You'll find the output from Webpack in the `dist/` directory, these are the sources that's bundled into the extension, so put breakpoints here.

## Testing

Before pushing back any changes or opening a pull request, you should run the tests locally.

```sh
npm run test
```

If you're on Linux and have [xvfb](https://www.x.org/releases/X11R7.7/doc/man/man1/Xvfb.1.xhtml) installed, you can run the tests in a headless process:

```sh
npm run test:headless
```

Check your distributions package manager for how to install it. On Debian based distributions for example, you can use `apt-file` to search for packages that provide the `xvfb-run` binary.

```sh
apt-file search xvfb-run
```
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "gitignore",
"displayName": "gitignore",
"description": "Lets you pull .gitignore templates from the https://github.com/github/gitignore repository. Language support for .gitignore files.",
"displayName": "%displayName%",
"description": "%description%",
"version": "0.9.0",
"author": "Marc-André Bühler",
"publisher": "codezombiech",
Expand Down Expand Up @@ -38,12 +38,12 @@
],
"configuration": {
"type": "object",
"title": "gitignore extension configuration",
"title": "%config.title%",
"properties": {
"gitignore.cacheExpirationInterval": {
"type": "integer",
"default": 3600,
"description": "Number of seconds the list of `.gitignore` files retrieved from github will be cached"
"description": "%config.cacheExpirationInterval%"
}
}
},
Expand Down
6 changes: 6 additions & 0 deletions package.nls.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"displayName": "gitignore",
"description": "Lets you pull .gitignore templates from the https://github.com/github/gitignore repository. Language support for .gitignore files.",
"config.title": "gitignore",
"config.cacheExpirationInterval": "Number of seconds the list of `.gitignore` files retrieved from github will be cached."
}