Skip to content

Commit

Permalink
Merge pull request wirecardBrasil#1 from moip/develop
Browse files Browse the repository at this point in the history
Adding contributing file and updating readme
  • Loading branch information
somentelucas committed Dec 13, 2017
2 parents 589a1d4 + 3946999 commit 7266f8f
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 2 deletions.
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Contributing
:clap::tada: Thank you for taking the time to contribute! :tada::clap:

We really value your willingness to contribute to this project. In order to higher the chances of your contribution being accepted, please refer to the following guidelines!

## Steps

1. Fork it!
2. Create your feature branch: `git checkout -b feature/xyz develop`
3. Commit your changes according to our commit message standards: `git commit -am 'feat(xyz) Added new functionality'`
4. Push to your repo: `git push origin feature/xyz`
5. Submit a pull request to `develop`

## Workflow
This repo uses Gitflow as its branch management system. You can learn more about Gitflow [here](https://www.atlassian.com/git/tutorials/comparing-workflows#gitflow-workflow).
A few quick tips:
* All feature branches should be based on `develop` and have the format `feature/branch_name`.
* Minor bug fixes should be based on `master` and have the format `hotfix/branch_name`.

### Commit Conventions
In order to make the changelog generation easier we recommend the use of messages based on [Conventional Commits](https://conventionalcommits.org/).

Examples:
```
feat(orders): added `XYZ` helper function
commit description
footer notes
```

```
refactor(orders): refactored `ABC` helper function
The behaviour of `ABC` was inconsistent and (...)
BREAKING CHANGE: return type of `ABC` is now `String`
```

```
docs: updated documentation in Request.php
```
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<img src="https://gist.githubusercontent.com/joaolucasl/00f53024cecf16410d5c3212aae92c17/raw/1789a2131ee389aeb44e3a9d5333f59cfeebc089/moip-icon.png" align="right" />

# Moip SDK Node
> O jeito mais simples e rápido de integrar o Moip a sua aplicação Node
> **[Em desenvolvimento - Não utilize em Produção**] Módulo Node.js para integração com a API Moip v2 e assinaturas
[![Build Status](https://travis-ci.org/Nucleus-Inc/moip-sdk-node.svg?branch=master)](https://travis-ci.org/Nucleus-Inc/moip-sdk-node)
Expand Down Expand Up @@ -324,7 +328,7 @@ moip.notification.getAll(function(error, body, response) {

## Referência API

[Documentação oficial v2](https://dev.moip.com.br/v2.0/reference)
[Documentação oficial v2](https://dev.moip.com.br/v2.1/reference)

[Documentação oficial Assinaturas](https://dev.moip.com.br/v1.5/reference)

Expand All @@ -339,4 +343,4 @@ moip.notification.getAll(function(error, body, response) {

## Licença

[The MIT License](https://github.com/Nucleus-Inc/moip-sdk-node/blob/master/LICENSE.txt)
[The MIT License](https://github.com/moip/moip-sdk-node/blob/master/LICENSE)

0 comments on commit 7266f8f

Please sign in to comment.