Skip to content

Commit

Permalink
Add github contribution boilerplate
Browse files Browse the repository at this point in the history
  • Loading branch information
CodaFi committed Feb 21, 2016
1 parent 74994c0 commit e132c44
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/CONTRIBUTING.md
@@ -0,0 +1,25 @@
We love that you're interested in contributing to this project!

To make the process as painless as possible, we have just a couple of guidelines
that should make life easier for everyone involved.

## Prefer Pull Requests

If you know exactly how to implement the feature being suggested or fix the bug
being reported, please open a pull request instead of an issue. Pull requests are easier than
patches or inline code blocks for discussing and merging the changes.

If you can't make the change yourself, please open an issue after making sure
that one isn't already logged.

## Contributing Code

Fork this repository, make it awesomer (preferably in a branch named for the
topic), send a pull request!

All code contributions should match our the framework's conventions. When in
doubt, you can look around the project for similar code, or just use [GitHub's
coding conventions](https://github.com/github/swift-style-guide).

Thanks for contributing! :boom::camel:

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -0,0 +1,35 @@
Version
========

_Share the git commit hash of the version of the framework that you are using. You can find it by running `git rev-parse HEAD` in the framework directory._

Environment
===========

_What's your environment? Mac OS X, Linux, or something else?_

Description
============

_In your own words, briefly describe the issue._

Steps To Reproduce
===================

_List the actions that will reproduce the issue._

Expected Result
================

_What was the expected result after running the steps above?_

Actual Result
==============

_What was the actual result after running the steps above?_

Additional information
======================

_Please provide any additional information that helps debugging, e.g. log output, stack traces, error codes, etc._

24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,24 @@
What's in this pull request?
============================

_Briefly describe the contents of this pull request. What did you add, remove,
change?_

Why merge this pull request?
============================

_Give us a short description of why this is important. For example, future
plans, cleanup, motivations for additional features, etc._

What's worth discussing about this pull request?
================================================

_Is there any part of this pull request that is especially important,
controversial, or that you're unsure of? We can totally help!_

What downsides are there to merging this pull request?
======================================================

_If you answered the last question in the affirmative, do you wish to discuss
alternative implementations or have any other overarching concerns?_

0 comments on commit e132c44

Please sign in to comment.