Skip to content

Latest commit

聽

History

History
86 lines (51 loc) 路 2.64 KB

CONTRIBUTING.md

File metadata and controls

86 lines (51 loc) 路 2.64 KB
Raw

Contributing

Thank's for you interest in contributing! 馃帀馃憤

This are the common guidelines to contribute to robrowser. Please ensure the following guidelines are being followed by you and any other contributor.

Code of conduct

This project and everyone participating in it is governed by the Pagar.me Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to developers@pagar.me.

How can I contribute?

Help us maintaining this project by reporting bugs, improving our codebase, creating more documentation and submiting new pull requests for features you would like to see in this project.

Guidelines 馃毃

Speak English

English is an universal language used across the world and in the vast majority of tools and coding vocabulary.

Write good commit messages

We follow the pagarme/git-style-guide. Every commit/branch/pull_request must follow its guidelines.

How to report a bug

If you find a security vulnerability, do NOT open an issue. Email developers@pagar.me instead.

When reporting a bug make sure to include:

  • The project version you are running
  • Your OS
  • Node.js version
  • Steps to reproduce
  • Current and expected behavior

Code style

Make sure that when writing code you are following Pagarme's style guide

Contributing

Fork the repo and clone it in your machine: git clone git@github.com:YOUR_USERNAME/robrowser.git

Install the dependencies

Although we higly recommend you using yarn for this project, we don't demand it, so feel free to use other package managers.

yarn

or

npm i

Make sure the tests are passing

yarn test

or

npm run test

Creating and improving stuff

All of the source files are placed under the ./src folder, their main objective is to export functions and deal with bussiness logic that will be used by the final executable file.

More tests

If you are adding more stuff, remember to add more tests to cover as much of the possible scenarios you can imagine.

We would be glad if you also improve our current tests, which are placed under the ./tests folder 馃榾

Opening your PR

  • Make sure the tests still passes (and that you added new ones if needed)
  • Fill the PR template when opening it trough GitHub
  • Include screenshots and animated GIFs whenever possible.

If in doubt, just send us a PR or open an issue to discussion! We're always happy for receiving contributions!