Skip to content

Commit

Permalink
style: automatic standards for markdown files (#625)
Browse files Browse the repository at this point in the history
  • Loading branch information
arturovt authored and just-jeb committed Nov 18, 2019
1 parent 5871f63 commit bed644e
Show file tree
Hide file tree
Showing 9 changed files with 249 additions and 190 deletions.
14 changes: 8 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
name: Bug report
about: Create a report to help us improve

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

*OR (preferred way)*
_OR (preferred way)_

a link to a repository with minimal reproduction
a link to a repository with minimal reproduction

**Expected behavior**
A clear and concise description of what you expected to happen.
Expand All @@ -25,11 +25,13 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem.

**Builder:**
- The name of the builder
- The version of the builder

- The name of the builder
- The version of the builder

**Libraries**
- `angular-devkit/build-angular`: version

- `angular-devkit/build-angular`: version

**Additional context**
Add any other context about the problem here.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Is your feature request related to a problem? Please describe.**
Expand Down
8 changes: 5 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
## PR Checklist

Please check if your PR fulfills the following requirements:

- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

```
[ ] Bugfix
[ ] Feature
Expand All @@ -20,21 +23,20 @@ What kind of change does this PR introduce?
```

## What is the current behavior?

<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->

Issue Number: N/A


## What is the new behavior?


## Does this PR introduce a breaking change?

```
[ ] Yes
[ ] No
```

<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->


## Other information
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
# @angular-builders [![Build Status](https://travis-ci.org/just-jeb/angular-builders.svg?branch=master)](https://travis-ci.org/just-jeb/angular-builders) ![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg) [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)

# @angular-builders [![Build Status](https://travis-ci.org/just-jeb/angular-builders.svg?branch=master)](https://travis-ci.org/just-jeb/angular-builders) ![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg) [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)

The purpose of this repository is to consolidate all the community builders for Angular build facade.

## The latest version of all the builders require Angular CLI 8 and incompatible with Angular CLI 7
## [Documentation for version 7](https://github.com/meltedspark/angular-builders/tree/7.x.x)

## [Documentation for version 7](https://github.com/meltedspark/angular-builders/tree/7.x.x)

## [Migration guide from version 7 to version 8](./MIGRATION.MD)

# Builders

- [Custom webpack builders](./packages/custom-webpack) (an alternative to `ng eject`) [![npm version](https://img.shields.io/npm/v/@angular-builders/custom-webpack.svg) <!-- ![npm (tag)](https://img.shields.io/npm/v/@angular-builders/custom-webpack/next.svg)--> ![npm](https://img.shields.io/npm/dm/@angular-builders/custom-webpack.svg)](https://www.npmjs.com/package/@angular-builders/custom-webpack)
- [Jest builder](./packages/jest) (allows running `ng test` with Jest) [![npm version](https://img.shields.io/npm/v/@angular-builders/jest.svg) ![npm](https://img.shields.io/npm/dm/@angular-builders/jest.svg)](https://www.npmjs.com/package/@angular-builders/jest)
- [Timestamp builder](./packages/timestamp) (an example builder from [this](https://medium.com/@justjeb/angular-cli-6-under-the-hood-builders-demystified-f0690ebcf01) article) [![npm version](https://img.shields.io/npm/v/@angular-builders/timestamp.svg) ![npm](https://img.shields.io/npm/dm/@angular-builders/timestamp.svg)](https://www.npmjs.com/package/@angular-builders/timestamp)
- [Custom webpack builders](./packages/custom-webpack) (an alternative to `ng eject`) [![npm version](https://img.shields.io/npm/v/@angular-builders/custom-webpack.svg) <!-- ![npm (tag)](https://img.shields.io/npm/v/@angular-builders/custom-webpack/next.svg)--> ![npm](https://img.shields.io/npm/dm/@angular-builders/custom-webpack.svg)](https://www.npmjs.com/package/@angular-builders/custom-webpack)
- [Jest builder](./packages/jest) (allows running `ng test` with Jest) [![npm version](https://img.shields.io/npm/v/@angular-builders/jest.svg) ![npm](https://img.shields.io/npm/dm/@angular-builders/jest.svg)](https://www.npmjs.com/package/@angular-builders/jest)
- [Timestamp builder](./packages/timestamp) (an example builder from [this](https://medium.com/@justjeb/angular-cli-6-under-the-hood-builders-demystified-f0690ebcf01) article) [![npm version](https://img.shields.io/npm/v/@angular-builders/timestamp.svg) ![npm](https://img.shields.io/npm/dm/@angular-builders/timestamp.svg)](https://www.npmjs.com/package/@angular-builders/timestamp)

# Get in touch
Have any questions? Would like to discuss something?

Have any questions? Would like to discuss something?
[Join](https://join.slack.com/t/angular-builders/shared_invite/enQtODM2MjU5MTYyMDk2LTcxODQ3NTExNDZkM2U0NWQ2NmVmZTAwZWNmOThhYjg4ZDlmMGFlNDZmYWQxYzU5ODIzYjdmZGFmNmUxNDBlY2E) @angular-builders on Slack!

# Further reading

[Angular CLI under the hood - builders demystified](https://blog.angularindepth.com/angular-cli-under-the-hood-builders-demystified-v2-e73ee0f2d811)

## Contributors ✨
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"build": "tsc && ts-node merge-schemes.ts",
"test": "jest src",
"e2e": "jest e2e",
"format": "prettier --write \"**/*.{js,ts,html}\""
"format": "prettier --write \"**/*.{js,ts,html,md}\""
},
"devDependencies": {
"@angular-devkit/build-angular": "^0.803.0",
Expand Down Expand Up @@ -51,7 +51,7 @@
}
},
"lint-staged": {
"*.ts": [
"*.{js,ts,html,md}": [
"prettier --write",
"git add"
]
Expand Down
Loading

0 comments on commit bed644e

Please sign in to comment.