Skip to content

Commit

Permalink
Twitter OSS: Add ISSUE_TEMPLATE
Browse files Browse the repository at this point in the history
Problem

Open source contributors don't have a standardized way of including information we
would like to be included when contributors open issues.

Solution

Create an ISSUE template for opening issues. The template is useful for customizing
and standardizing information we'd like to have contributors include when opening
an issue against a library.

Result

More help when creating issues in our Twitter OSS repositories.

RB_ID=849239
  • Loading branch information
cacoco authored and jenkins committed Jul 7, 2016
1 parent d55b925 commit b3f8433
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
One line summary of the issue here.

### Expected behavior

As concisely as possible, describe the expected behavior.

### Actual behavior

As concisely as possible, describe the observed behavior.

### Steps to reproduce the behavior

Please list all relevant steps to reproduce the observed behavior.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,26 @@ locally).
We generally follow [Effective Scala][es] and the [Scala Style Guide][ssg]. When
in doubt, look around the codebase and see how it's done elsewhere.

## Issues

When creating an issue please try to ahere to the following format:

One line summary of the issue (less than 72 characters)

### Expected behavior

As concisely as possible, describe the expected behavior.

### Actual behavior

As concisely as possible, describe the observed behavior.

### Steps to reproduce the behavior

List all relevant steps to reproduce the observed behavior.

## Pull Requests

Comments should be formatted to a width no greater than 80 columns.

Files should be exempt of trailing spaces.
Expand Down

0 comments on commit b3f8433

Please sign in to comment.