Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.46 KB
Raw

Introduction

Thanks for contribute for this project!

First off, thank you for considering contributing to Swapi Helper. It's people like you that make Swapi Helper such a great tool.

[source: Swapi Helper]

Why it's important to read the guidelines.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

What kind of contributions are good?.

  • Documentation
  • Code Review and Improvement
  • Unit tests
  • Bug Fixing

Responsibilities

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
  • Ensure that code that goes into core meets all requirements in this checklist: https://gist.github.com/audreyr/4feef90445b9680475f2
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Don't add any classes to the codebase unless absolutely needed. Err on the side of using functions.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Python Community Code of Conduct.