lint(github): add headers to issue template, lint line length
This commit is contained in:
parent
a58862e540
commit
d999d67035
|
@ -7,11 +7,15 @@ assignees: ''
|
|||
|
||||
---
|
||||
|
||||
### Summary
|
||||
# Bug
|
||||
|
||||
Something is broken!
|
||||
|
||||
## Summary
|
||||
|
||||
(quick summary of the issue)
|
||||
|
||||
### Steps to Reproduce
|
||||
## Steps to Reproduce
|
||||
|
||||
- install
|
||||
- configure
|
||||
|
@ -19,18 +23,18 @@ assignees: ''
|
|||
- ...
|
||||
- :(
|
||||
|
||||
### Actual Behavior
|
||||
## Actual Behavior
|
||||
|
||||
```none
|
||||
example
|
||||
```
|
||||
|
||||
### Expected Behavior
|
||||
## Expected Behavior
|
||||
|
||||
```none
|
||||
example
|
||||
```
|
||||
|
||||
### Details
|
||||
## Details
|
||||
|
||||
(detailed description of the expected behavior and what goes wrong)
|
||||
|
|
|
@ -7,22 +7,26 @@ assignees: ''
|
|||
|
||||
---
|
||||
|
||||
### Summary
|
||||
# Feature
|
||||
|
||||
Something is missing!
|
||||
|
||||
## Summary
|
||||
|
||||
An elevator pitch of the feature and why it will be useful.
|
||||
|
||||
### Scope
|
||||
## Scope
|
||||
|
||||
- [ ] items to be implemented
|
||||
- [ ] additional details
|
||||
|
||||
### Use Case
|
||||
## Use Case
|
||||
|
||||
At least one concrete use case for the feature, ideally with step-by-step example.
|
||||
|
||||
Bonus points if you can refer to another issue here.
|
||||
|
||||
### Questions
|
||||
## Questions
|
||||
|
||||
Outstanding questions, potential problems, and further research that might be needed.
|
||||
|
||||
|
|
|
@ -1,30 +0,0 @@
|
|||
---
|
||||
name: Dependency Update
|
||||
about: update a dependency
|
||||
title: ''
|
||||
labels: status/new, type/update
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
### Summary
|
||||
|
||||
(what needs to be updated)
|
||||
|
||||
### Version
|
||||
|
||||
- current version
|
||||
- target version
|
||||
- latest version (if target < latest)
|
||||
|
||||
### Use Case
|
||||
|
||||
(at least one solid use case for the update)
|
||||
|
||||
### Issues
|
||||
|
||||
(potential problems, questions, research)
|
||||
|
||||
### Details
|
||||
|
||||
(other changes that need to happen first)
|
27
README.md
27
README.md
|
@ -74,8 +74,8 @@ Once your project is set up:
|
|||
- commit
|
||||
- `make git-push`
|
||||
|
||||
The `git-push` target pushes to Github first, to avoid conflicts with changes from bots and
|
||||
other contributors.
|
||||
The `git-push` target pushes to Github first, to avoid conflicts with changes
|
||||
from bots and other contributors.
|
||||
|
||||
### To Release
|
||||
|
||||
|
@ -84,18 +84,18 @@ When your project is ready to release:
|
|||
- `make release-dry` to make sure your changelog and options look right
|
||||
- `make release`
|
||||
|
||||
Additional options can be passed with the `RELEASE_OPTS` variable. Frequently-used options
|
||||
include `--release-as minor` and `--prerelease`.
|
||||
Additional options can be passed with the `RELEASE_OPTS` variable. Frequently
|
||||
used options include `--release-as minor` and `--prerelease`.
|
||||
|
||||
## External Services
|
||||
|
||||
This template works with or expects a few external services, namely a Gitlab CI server
|
||||
(self-hosted or using Gitlab.com).
|
||||
This template works with or expects a few external services, namely a Gitlab
|
||||
CI server (self-hosted or using Gitlab.com).
|
||||
|
||||
### Maintenance Bots
|
||||
|
||||
Good tests and clever bots can eliminate the most painful parts of project maintenance. This
|
||||
repository is configured to work with:
|
||||
Good tests and clever bots can eliminate the most painful parts of project
|
||||
maintenance. This repository is configured to work with:
|
||||
|
||||
- [CodeCov](https://codecov.io/)
|
||||
- [Code Climate](https://codeclimate.com/)
|
||||
|
@ -104,13 +104,13 @@ repository is configured to work with:
|
|||
- [Snyk](https://snyk.io/)
|
||||
- [SonarCloud](https://sonarcloud.io/)
|
||||
|
||||
None of these are required, but Renovate and Snyk can be very helpful when dependencies release
|
||||
a security patch (and even more so when they decline).
|
||||
None of these are required, but Renovate and Snyk can be very helpful when
|
||||
dependencies release a security patch (and even more so when they decline).
|
||||
|
||||
## External Secrets
|
||||
|
||||
This template expects a few secrets to exist in the environment, including tokens for
|
||||
the [external services](#external-services).
|
||||
This template expects a few secrets to exist in the environment, including
|
||||
tokens for the [external services](#external-services).
|
||||
|
||||
| Name | Description |
|
||||
| ------------------- | ----------------------------------------------------- |
|
||||
|
@ -122,4 +122,5 @@ the [external services](#external-services).
|
|||
| NPM_SECRET | npmjs.com token, required for publishing npm packages |
|
||||
| SONAR_SECRET | sonarcloud token |
|
||||
|
||||
Secrets should be provided as environment variables, with the secret value `base64`-encoded.
|
||||
Secrets should be provided as environment variables, with the secret value
|
||||
`base64`-encoded.
|
||||
|
|
Loading…
Reference in New Issue