Skip to content

Commit 02833e1

Browse files
lindsaylevinelindsaylevine
authored
chore: repo standards (#10)
* chore: repo standards * chore: rename to essential angular universal plugin * chore: add release-please & pr labeler * chore: add empty changelog.md
1 parent 330471a commit 02833e1

File tree

7 files changed

+143
-2
lines changed

7 files changed

+143
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Versions**
24+
- Angular.js:
25+
- plugin (if installed in your package.json at fixed version):
26+
27+
**If you're using the CLI to build**
28+
- OS: [e.g. macOS, Windows]
29+
- netlify/cli version:
30+
31+
**If you're using file-based installation**
32+
- netlify.toml:

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/workflows/labeler.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Label PR
2+
on:
3+
pull_request:
4+
types: [opened, edited]
5+
6+
jobs:
7+
label-pr:
8+
if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false
9+
runs-on: ubuntu-latest
10+
strategy:
11+
matrix:
12+
pr:
13+
[
14+
{ prefix: 'fix', type: 'bug' },
15+
{ prefix: 'chore', type: 'chore' },
16+
{ prefix: 'test', type: 'chore' },
17+
{ prefix: 'ci', type: 'chore' },
18+
{ prefix: 'feat', type: 'feature' },
19+
{ prefix: 'security', type: 'security' },
20+
]
21+
steps:
22+
- uses: netlify/[email protected]
23+
if: startsWith(github.event.pull_request.title, matrix.pr.prefix)
24+
with:
25+
token: '${{ secrets.GITHUB_TOKEN }}'
26+
label: 'type: ${{ matrix.pr.type }}'

‎.github/workflows/release-please.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: release-please
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
release-please:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: navikt/github-app-token-generator@2d70c12368d1958155af4d283f9f21c9a2a8cb98
11+
id: get-token
12+
with:
13+
private-key: ${{ secrets.TOKENS_PRIVATE_KEY }}
14+
app-id: ${{ secrets.TOKENS_APP_ID }}
15+
- uses: GoogleCloudPlatform/release-please-action@v2
16+
with:
17+
token: ${{ steps.get-token.outputs.token }}
18+
release-type: node
19+
package-name: '@netlify/plugin-angular-universal'

‎CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Changelog
2+
3+

‎README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![Netlify Build plugin Angular Serverless – Run Angular Universal seamlessly on Netlify](netlify-plugin-angular.png)
22

3-
# Angular Universal Plugin
3+
# Essential Angular Universal Plugin
44

55
This build plugin is a utility for supporting Angular Universal on Netlify.
66

@@ -9,6 +9,9 @@ This build plugin is a utility for supporting Angular Universal on Netlify.
99
- [Installation and Configuration](#installation-and-configuration)
1010
- [CLI Usage](#cli-usage)
1111
- [Caveats](#caveats)
12+
- [Getting Help](#getting-help)
13+
- [Contributing](#contributing)
14+
- [License](#license)
1215

1316
## Installation and Configuration
1417

@@ -69,4 +72,23 @@ This plugin is currently in beta.
6972

7073
Right now:
7174
- it does not include out of the box monorepo support
72-
- it does not support Angular Universal prerendering
75+
- it does not support Angular Universal prerendering
76+
77+
## Getting Help
78+
79+
We love to hear from you so if you have questions, comments or find a bug in the
80+
project, let us know! You can either:
81+
82+
- Open an issue on this repository
83+
- Tweet at us! We're [@Netlify on Twitter](https://twitter.com/Netlify)
84+
- Or, [join the community forums](https://answers.netlify.com)
85+
86+
## Contributing
87+
88+
We welcome contributions ❤️ - see the [CONTRIBUTING.md](docs/CONTRIBUTING.md) file
89+
for details.
90+
91+
## License
92+
93+
This project is licensed under the MIT License - see the
94+
[LICENSE.md](LICENSE.md) file for details

‎docs/CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish
4+
to make via issue, email, or any other method with the owners of this repository
5+
before making a change.
6+
7+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
8+
all your interactions with the project.
9+
10+
## How to write commit messages
11+
12+
We use [Conventional Commit messages](https://www.conventionalcommits.org/) to
13+
automate version management.
14+
15+
Most common commit message prefixes are:
16+
17+
- `fix:` which represents bug fixes, and generate a patch release.
18+
- `feat:` which represents a new feature, and generate a minor release.
19+
- `feat!:`, `fix!:` or `refactor!:` and generate a major release.

0 commit comments

Comments
 (0)