Skip to content
Permalink
Browse files

📝 Add CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md

Support #82
  • Loading branch information...
usatie committed Aug 20, 2018
1 parent 1eff085 commit 241a9c2a71c5832022f20fde300244ff72be0339
Showing with 110 additions and 0 deletions.
  1. +29 −0 .github/PULL_REQUEST_TEMPLATE.md
  2. +81 −0 CONTRIBUTING.md
@@ -0,0 +1,29 @@
### Requirements

* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.

### Description of the Change

<!--
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
-->

### Alternate Designs

<!-- Explain what other alternates were considered and why the proposed version was selected -->


### Benefits

<!-- What benefits will be realized by the code change? -->

### Possible Drawbacks

<!-- What are the possible side-effects or negative impacts of the code change? -->

### Applicable Issues

<!-- Enter any applicable Issues here -->

@@ -0,0 +1,81 @@
CONTRIBUTING.md
# Contributing to BitcoinKit

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to BitcoinKit, which are hosted in the [Yenom Organization](https://github.com/yenom) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

#### Table Of Contents

[Code of Conduct](#code-of-conduct)

[Where Can I Ask a Question?](#where-can-i-ask-a-question)

[How Can I Contribute?](#how-can-i-contribute)
* [Reporting Bugs](#reporting-bugs)
* [Suggesting Enhancements](#suggesting-enhancements)
* [Your First Code Contribution](#your-first-code-contribution)
* [Pull Requests](#pull-requests)

[Styleguides](#styleguides)
* [Git Commit Messages](#git-commit-messages)

## Code of Conduct
This project and everyone participating in it is governed by this code. By participating, you are expected to uphold this code.

* Be Nice.
* Use English.

## Where Can I Ask a Question?
You can ask a question on github issues at any time. We'll soon launch a Slack group to ask a question.

## How Can I Contribute?

### Reporting Bugs
Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.

### Suggesting Enhancements
Please provide the following information:

* **Use a clear and descriptive title** for the issue to identify the suggestion.
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
* **Explain why** this enhancement would be useful to most BitcoinKit users.
* List some **other implementations where this enhancement exists.**
* Specify which **version of BitcoinKit** you're using.
* Specify **the name and version of the OS** you're using.

### Your First Code Contribution

Unsure where to begin contributing to BitcoinKit? You can start by looking through these `beginner-welcome` issues:

* [Beginner issues][beginner-welcome] - issues which should only require a few lines of code, and a test or two.


### Pull Requests

* Fill in [the required template](.github/PULL_REQUEST_TEMPLATE.md)
* Use a clear and descriptive title for the PR.
* Describe the PR clearly.
* Check with [SwiftLint](https://github.com/realm/SwiftLint) before creating a PR

## Styleguides

## Git Commit Messages
* Use the present tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
* Consider starting the commit message with an applicable emoji:
* :rocket: `:rocket:` when releasing a new version
* :sparkles: `:sparkles:` when adding a new file/feature
* :recycle: `:recycle:` when refactoring the format/structure of code
* :racehorse: `:racehorse:` when improving performance
* :non-potable_water: `:non-potable_water:` when plugging memory leaks
* :memo: `:memo:` when writing docs
* :bug: `:bug:` when fixing a bug
* :fire: `:fire:` when removing code or files
* :green_heart: `:green_heart:` when fixing the CI build
* :white_check_mark: `:white_check_mark:` when adding tests
* :lock: `:lock:` when dealing with security
* :arrow_up: `:arrow_up:` when upgrading dependencies
* :arrow_down: `:arrow_down:` when downgrading dependencies
* :shirt: `:shirt:` when removing linter warnings

0 comments on commit 241a9c2

Please sign in to comment.
You can’t perform that action at this time.