Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.64 KB

Contributing guidelines

Pull Request Checklist

Before sending your pull requests, make sure you followed this list.

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:

  • If your contribution is minor, such as a typo fix, open a pull request.
  • If your contribution is major, such as a new guide, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Community

Discussions about the Open Source Guides take place on this repository's Issues and Pull Requests sections. We have also available a public gitter room and anybody is welcome to join these conversations. Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly.

Overview

Being an Open Source project, everyone can contribute, provided that it respect the following points:

  • Before contributing any code, the author must make sure all the tests work.
  • Developed code must adhere to the syntax guidelines enforced by the black code formatter.
  • Code must be developed following the branching model.
  • For any new feature added, tests shlould be provided, following the example of the ones already created.