Merge branch 'master' into author-improvement
This commit is contained in:
commit
e2955ca2e3
44
.github/ISSUE_TEMPLATE/v1-bug-report.md
vendored
Normal file
44
.github/ISSUE_TEMPLATE/v1-bug-report.md
vendored
Normal file
@ -0,0 +1,44 @@
|
||||
---
|
||||
name: v1 bug report
|
||||
about: Create a report to help us fix v1 bugs
|
||||
title: 'v1 bug: ( your bug title goes here )'
|
||||
labels: 'type: bug, status: triage, version: v1'
|
||||
assignees: lynncyrin
|
||||
|
||||
---
|
||||
|
||||
## Checklist
|
||||
|
||||
* [ ] Are you running the latest v1 release? The list of releases is [here](https://github.com/urfave/cli/releases).
|
||||
* [ ] Did you check the manual for your release? The v1 manual is [here](https://github.com/urfave/cli/blob/master/docs/v1/manual.md)
|
||||
* [ ] Did you perform a search about this problem? Here's the [Github guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching.
|
||||
|
||||
## Describe the bug
|
||||
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
## To reproduce
|
||||
|
||||
Describe the steps or code required to reproduce the behavior
|
||||
|
||||
## Expected behavior
|
||||
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
## Additional context
|
||||
|
||||
Add any other context about the problem here.
|
||||
|
||||
If the issue relates to a specific open source Github repo, please link that repo here.
|
||||
|
||||
If you can reproduce this issue with a public CI system, please link a failing build here.
|
||||
|
||||
## Want to fix this yourself?
|
||||
|
||||
We'd love to have more contributors on this project! If the fix for this bug is easily explained and very small, free free to create a pull request for it. You'll want to base the PR off the `v1` branch, all `v1` bug fix releases will be made from that branch.
|
||||
|
||||
## Run `go env` and paste its output here
|
||||
|
||||
```
|
||||
# paste it in here
|
||||
```
|
44
.github/ISSUE_TEMPLATE/v2-bug-report.md
vendored
Normal file
44
.github/ISSUE_TEMPLATE/v2-bug-report.md
vendored
Normal file
@ -0,0 +1,44 @@
|
||||
---
|
||||
name: v2 bug report
|
||||
about: Create a report to help us fix v2 bugs
|
||||
title: 'v2 bug: ( your bug title goes here )'
|
||||
labels: 'type: bug, version: v2, status: triage'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Checklist
|
||||
|
||||
* [ ] Are you running the latest v2 release? The list of releases is [here](https://github.com/urfave/cli/releases).
|
||||
* [ ] Did you check the manual for your release? The v2 manual is [here](https://github.com/urfave/cli/blob/master/docs/v2/manual.md)
|
||||
* [ ] Did you perform a search about this problem? Here's the [Github guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching.
|
||||
|
||||
## Describe the bug
|
||||
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
## To reproduce
|
||||
|
||||
Describe the steps or code required to reproduce the behavior
|
||||
|
||||
## Expected behavior
|
||||
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
## Additional context
|
||||
|
||||
Add any other context about the problem here.
|
||||
|
||||
If the issue relates to a specific open source Github repo, please link that repo here.
|
||||
|
||||
If you can reproduce this issue with a public CI system, please link a failing build here.
|
||||
|
||||
## Want to fix this yourself?
|
||||
|
||||
We'd love to have more contributors on this project! If the fix for this bug is easily explained and very small, free free to create a pull request for it.
|
||||
|
||||
## Run `go env` and paste its output here
|
||||
|
||||
```
|
||||
# paste it in here
|
||||
```
|
30
.github/ISSUE_TEMPLATE/v2-feature-request.md
vendored
Normal file
30
.github/ISSUE_TEMPLATE/v2-feature-request.md
vendored
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
name: v2 feature request
|
||||
about: Suggest an improvement for v2
|
||||
title: 'v2 feature: ( your feature title goes here )'
|
||||
labels: 'type: feature, version: v2, status: triage'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Checklist
|
||||
|
||||
* [ ] Are you running the latest v2 release? The list of releases is [here](https://github.com/urfave/cli/releases).
|
||||
* [ ] Did you check the manual for your release? The v2 manual is [here](https://github.com/urfave/cli/blob/master/docs/v2/manual.md)
|
||||
* [ ] Did you perform a search about this feature? Here's the [Github guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching.
|
||||
|
||||
## What problem does this solve?
|
||||
|
||||
A clear and concise description of what problem this feature would solve. For example:
|
||||
|
||||
- needing to type out the full flag name takes a long time, so I would like to suggest adding auto-complete
|
||||
- I use (osx, windows, linux) and would like support for (some existing feature) to be extended to my platform
|
||||
- the terminal output for a particular error case is confusing, and I think it could be improved
|
||||
|
||||
## Solution description
|
||||
|
||||
A detailed description of what you want to happen.
|
||||
|
||||
## Describe alternatives you've considered
|
||||
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
64
README.md
64
README.md
@ -15,10 +15,40 @@ applications in an expressive way.
|
||||
|
||||
## Usage Documentation
|
||||
|
||||
Usage documentation exists for each major version
|
||||
Usage documentation exists for each major version. Don't know what version you're on? You're probably using the version from the `master` branch, which is currently `v2`.
|
||||
|
||||
- `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)
|
||||
- `v2` - [./docs/v2/manual.md](./docs/v2/manual.md)
|
||||
- `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)
|
||||
|
||||
### Using `v2` releases
|
||||
|
||||
**Warning**: `v2` is in a beta state.
|
||||
|
||||
```
|
||||
$ go get github.com/urfave/cli.v2
|
||||
```
|
||||
|
||||
```go
|
||||
...
|
||||
import (
|
||||
"github.com/urfave/cli/v2" // imports as package "cli"
|
||||
)
|
||||
...
|
||||
```
|
||||
|
||||
### Using `v1` releases
|
||||
|
||||
```
|
||||
$ go get github.com/urfave/cli
|
||||
```
|
||||
|
||||
```go
|
||||
...
|
||||
import (
|
||||
"github.com/urfave/cli"
|
||||
)
|
||||
...
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
@ -38,33 +68,3 @@ export PATH=$PATH:$GOPATH/bin
|
||||
cli is tested against multiple versions of Go on Linux, and against the latest
|
||||
released version of Go on OS X and Windows. For full details, see
|
||||
[`./.travis.yml`](./.travis.yml) and [`./appveyor.yml`](./appveyor.yml).
|
||||
|
||||
### Using `v1` releases
|
||||
|
||||
```
|
||||
$ go get github.com/urfave/cli
|
||||
```
|
||||
|
||||
```go
|
||||
...
|
||||
import (
|
||||
"github.com/urfave/cli"
|
||||
)
|
||||
...
|
||||
```
|
||||
|
||||
### Using `v2` releases
|
||||
|
||||
**Warning**: `v2` is in a beta state.
|
||||
|
||||
```
|
||||
$ go get github.com/urfave/cli.v2
|
||||
```
|
||||
|
||||
```go
|
||||
...
|
||||
import (
|
||||
"github.com/urfave/cli.v2" // imports as package "cli"
|
||||
)
|
||||
...
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user