Docs cleanup

.github/ISSUE_TEMPLATE/ask-for-help.md → .github/ISSUE_TEMPLATE/question.md

@@ -2,7 +2,7 @@
 name: Ask for help
 about: Suggest an idea for this project or ask for help
 title: ''
-labels: 'Help Wanted'
+labels: 'Question'
 assignees: ''
 
 ---

CONTRIBUTING.md

@@ -4,48 +4,26 @@
 
 The following is a set of guidelines to follow when contributing to this package. These are not hard rules, please use common sense and feel free to propose changes to this document in a pull request.
 
-## Table of Contents
-
-1. [Code of Conduct](#code-of-conduct)
-1. [Getting Help](#getting-help)
-1. [Filing a Bug Report](#how-to-file-a-bug-report)
-1. [Suggesting an API change](#suggesting-an-api-change)
-1. [Submitting a Contribution](#submitting-a-contribution)
-1. [Writing and Running Tests](#writing-and-running-tests)
-
 ## Code of Conduct
 
 This project and its contibutors are expected to uphold the [Go Community Code of Conduct](https://golang.org/conduct). By participating, you are expected to follow these guidelines.
 
 ## Getting help
 
-Feel free to [open up an issue](https://github.com/AlecAivazis/survey/v2/issues/new) on GitHub when asking a question so others will be able to find it. Please remember to tag the issue with the `Question` label so the maintainers can get to your question as soon as possible. If the question is urgent, feel free to reach out to `@AlecAivazis` directly in the gophers slack channel.
-
-## How to file a bug report
-
-Bugs are tracked using the Github Issue tracker. When filing a bug, please remember to label the issue as a `Bug` and answer/provide the following:
-
-1. What operating system and terminal are you using?
-1. An example that showcases the bug.
-1. What did you expect to see?
-1. What did you see instead?
-
-## Suggesting an API change
-
-If you have an idea, I'm more than happy to discuss it. Please open an issue and we can work through it. In order to maintain some sense of stability, additions to the top-level API are taken just as seriously as changes that break it. Adding stuff is much easier than removing it.
+* [Open an issue](https://github.com/AlecAivazis/survey/issues/new/choose)
+* Reach out to `@AlecAivazis` or `@mislav` in the Gophers slack (please use only when urgent)
 
 ## Submitting a contribution
 
-In order to maintain stability, most features get fully integrated in more than one PR. This allows for more opportunity to think through each API change without amassing large amounts of tech debt and API changes at once. If your feature can be broken into separate chunks, it will be able to be reviewed much quicker. For example, if the PR that implemented the `Validate` field was submitted in a PR separately from one that included `survey.Required`, it would be able to get merge without having to decide how many different `Validators` we want to provide as part of `survey`'s API.
-
 When submitting a contribution,
 
-- Provide a description of the feature or change
-- Reference the ticket addressed by the PR if there is one
-- Following community standards, add comments for all exported members so that all necessary information is available on godocs
-- Remember to update the project README.md with changes to the high-level API
-- Include both positive and negative unit tests (when applicable)
-- Contributions with visual ramifications or interaction changes should be accompanied with the appropriate `go-expect` tests. For more information on writing these tests, see [Writing and Running Tests](#writing-and-running-tests)
+- Try to make a series of smaller changes instead of one large change
+- Provide a description of each change that you are proposing
+- Reference the issue addressed by your pull request (if there is one)
+- Document all new exported Go APIs
+- Update the project's README when applicable
+- Include unit tests if possible
+- Contributions with visual ramifications or interaction changes should be accompanied with an integration test—see below for details.
 
 ## Writing and running tests
 

README.md

@@ -56,39 +56,12 @@ func main() {
 }
 ```
 
-## Table of Contents
-
-1. [Examples](#examples)
-1. [Running the Prompts](#running-the-prompts)
-1. [Prompts](#prompts)
-   1. [Input](#input)
-      1. [Suggestion Options](#suggestion-options)
-   1. [Multiline](#multiline)
-   1. [Password](#password)
-   1. [Confirm](#confirm)
-   1. [Select](#select)
-   1. [MultiSelect](#multiselect)
-   1. [Editor](#editor)
-1. [Filtering Options](#filtering-options)
-1. [Validation](#validation)
-   1. [Built-in Validators](#built-in-validators)
-1. [Help Text](#help-text)
-   1. [Changing the input rune](#changing-the-input-rune)
-1. [Changing the Icons ](#changing-the-icons)
-1. [Custom Types](#custom-types)
-1. [Testing](#testing)
-1. [FAQ](#faq)
-
 ## Examples
 
 Examples can be found in the `examples/` directory. Run them
 to see basic behavior:
 
 ```bash
-go get github.com/AlecAivazis/survey/v2
-
-cd $GOPATH/src/github.com/AlecAivazis/survey
-
 go run examples/simple.go
 go run examples/validation.go
 ```