Skip to content

Commit e0732f3

Browse files
committed
Adds many standard GitHub templates/files
Switches to yarn
1 parent c7c3496 commit e0732f3

15 files changed

+693
-7
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@eamodio

.github/FUNDING.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: [eamodio]
4+
patreon: eamodio

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help improve TypeScript + Webpack Problem Matchers
4+
title: ''
5+
labels: 'type: potential bug'
6+
assignees: ''
7+
---
8+
9+
<!-- Please search existing issues to avoid creating duplicates. -->
10+
11+
- TypeScript + Webpack Problem Matchers Version:
12+
<!-- Use Help > Report Issue to prefill these. -->
13+
- VSCode Version:
14+
- OS Version:
15+
16+
Steps to Reproduce:
17+
18+
1.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for TypeScript + Webpack Problem Matchers
4+
title: ''
5+
labels: 'type: feature'
6+
assignees: ''
7+
---
8+
9+
<!-- Please search existing issues to avoid creating duplicates. -->
10+
11+
<!-- Describe the feature you'd like. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Question
3+
about: Ask a question about TypeScript + Webpack Problem Matchers
4+
title: ''
5+
labels: 'type: question'
6+
assignees: ''
7+
---
8+
9+
<!-- Please search existing issues to avoid creating duplicates. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Thank you for taking the time to contribute to TypeScript + Webpack Problem Matchers! ♥
2+
3+
### 🚨 IMPORTANT 🚨
4+
5+
- Please create an issue _before_ creating a Pull Request
6+
- Please ensure to use the `master` branch as the base for all PRs
7+
- Please use the following Git commit message style
8+
- Use the future tense ("Adds feature" not "Added feature")
9+
- Use a "Fixes #xxx -" or "Closes #xxx -" prefix to auto-close the issue that your PR addresses
10+
- Limit the first line to 72 characters or less
11+
- Reference issues and pull requests liberally after the first line
12+
13+
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
14+
15+
<!-- Delete everything above here before submitting -->
16+
17+
# Description
18+
19+
<!--
20+
Please include a summary of the changes and which issue will be addressed. Please also include relevant motivation and context.
21+
-->
22+
23+
# Checklist
24+
25+
<!-- Please check off the following -->
26+
27+
- [ ] I have followed the guidelines in the Contributing document
28+
- [ ] My changes are based off of the `master` branch
29+
- [ ] My changes follow the coding style of this project
30+
- [ ] My changes build without any errors or warnings
31+
- [ ] My changes have been formatted and linted
32+
- [ ] My changes include any required corresponding changes to the documentation
33+
- [ ] My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
34+
- [ ] My changes have a descriptive commit message with a short title, including a `Fixes $XXX -` or `Closes #XXX -` prefix to auto-close the issue that your PR addresses

.vscode/launch.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// A launch configuration that compiles the extension and then opens it inside a new window
2+
{
3+
"version": "0.2.0",
4+
"configurations": [
5+
{
6+
"name": "Launch Extension",
7+
"type": "extensionHost",
8+
"request": "launch",
9+
"runtimeExecutable": "${execPath}",
10+
"args": ["--extensionDevelopmentPath=${workspaceFolder}"],
11+
"cwd": "${workspaceFolder}"
12+
}
13+
]
14+
}

.vscodeignore

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1+
.github/**
12
.vscode/**
3+
node_modules/**
24
src/**
5+
test/**
6+
*.map
7+
.gitattributes
38
.gitignore
4-
package-lock.json
9+
.prettierrc
10+
.yarnrc
11+
CODE_OF_CONDUCT.md
12+
CONTRIBUTING.md
13+
yarn.lock

.yarnrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ignore-engines true

CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at eamodio@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing
2+
3+
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
4+
5+
When contributing to this project, please first discuss the changes you wish to make via an issue before making changes.
6+
7+
Please note the [Code of Conduct](CODE_OF_CONDUCT.md) document, please follow it in all your interactions with this project.
8+
9+
## Your First Code Contribution
10+
11+
Unsure where to begin contributing? You can start by looking through the [`help-wanted`](https://github.com/eamodio/vscode-tsl-problem-matcher/labels/help%20wanted) issues.
12+
13+
### Getting the code
14+
15+
```
16+
git clone https://github.com/eamodio/vscode-tsl-problem-matcher.git
17+
```
18+
19+
Prerequisites
20+
21+
- [Git](https://git-scm.com/)
22+
- [NodeJS](https://nodejs.org/), `>= 10.11.0`
23+
- [yarn](https://yarnpkg.com/), `>= 1.17.3`
24+
25+
### Dependencies
26+
27+
From a terminal, where you have cloned the repository, execute the following command to install the required dependencies:
28+
29+
```
30+
yarn --frozen-lockfile
31+
```
32+
33+
### Formatting
34+
35+
This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `yarn run pretty` from a terminal.
36+
37+
To format the code as you make changes you can install the [Prettier - Code formatter](https://marketplace.visualstudio.com/items/esbenp.prettier-vscode) extension.
38+
39+
Add the following to your User Settings to run prettier:
40+
41+
```
42+
"editor.formatOnSave": true,
43+
```
44+
45+
### Bundling
46+
47+
To generate a VSIX (installation package) run the following from a terminal:
48+
49+
```
50+
yarn run pack
51+
```
52+
53+
## Submitting a Pull Request
54+
55+
Please follow all the instructions in the [PR template](.github/PULL_REQUEST_TEMPLATE.md).

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2018 Eric Amodio
3+
Copyright (c) 2018-2019 Eric Amodio
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"url": "https://github.com/eamodio/vscode-tsl-problem-matcher.git"
1919
},
2020
"engines": {
21-
"vscode": "^1.25.0"
21+
"vscode": "^1.37.0"
2222
},
2323
"categories": [
2424
"Programming Languages"
@@ -196,11 +196,11 @@
196196
]
197197
},
198198
"scripts": {
199-
"pack": "vsce package",
200-
"postinstall": "node ./node_modules/vscode/bin/install",
201-
"pub": "vsce publish"
199+
"pack": "vsce package --yarn",
200+
"pub": "vsce publish --yarn"
202201
},
203202
"devDependencies": {
204-
"vscode": "1.1.21"
203+
"@types/vscode": "1.37.0",
204+
"vsce": "1.68.0"
205205
}
206206
}

0 commit comments

Comments
 (0)