Skip to content

Latest commit

 

History

History
110 lines (83 loc) · 7.54 KB

CONTRIBUTING.md

File metadata and controls

110 lines (83 loc) · 7.54 KB
Raw

Contributing guidelines

Thank you for you contribution. It's really appreciated.

Set of guidelines follows. Use your best judgment, the world is not black and white and these guidelines are not hard rules.

Table of contents

How can I contribute?

Reporting bugs

Before submitting a bug report

  • Check the forum for a list of common issues and possible workarounds.
  • Check wheter the issue you are experiencing is already reported. If it is already reported, you can click on the Subscribe button to receive further development info or you can add more details.
  • Check if you're using the latest Pythonista version. Bug reports should be based on the latest available version. If you're using Pythonista beta version, test your issue with the latest available version from the Test Flight.

How do I submit a bug report?

  • Isolate problem - The first step is to identify what the problem is. Saying "something is wrong" is not helpful. Saying what exactly is wrong, how to reproduce it, is.
  • Separate issues - If you have multiple issues, please, file them separately.
  • Use clear and descriptive title - title like "help system" is not helpful.
  • Steps to reproduce - Include all steps how to reproduce your issue. More details, faster resolution. Don't just say what you did, but explain how you did it (tapping on, hw keyboard, ...).
  • Expected behavior - If something doesn't work as expected, include what exactly should happen.
  • Sample code - Sample code demonstrating your issue is very helpful. If it's short, include it directly in the issue. Read Quoting code to learn how to include code in the issue. Gist is preferred in case your code is too long.
  • System information - It's always good to attach system information.
  • Ask yourself - Is my description detailed enough that everyone understands what's my problem?

System information

Here's an example of system information to attach (preformatted Markdown):

**System Information**

* Pythonista 3.1.1 (311015), Default interpreter 3.6.1
* iOS 11.0.3, model iPad, resolution (portrait) 2048.0 x 2732.0 @ 2.0

If you don't know from where to get this information, download and run sysinfo.py script.

Why? Some bugs may appear on specific device, specific iOS version and it's very helpful to know more about your system. Problem can be identified and fixed more quickly.

If you feel bad about sharing system information of your device, don't attach it. It's not mandatory, but it's really helpful.

Issue labels

  • It's not required that every issue must have a label from every group
  • Issue can have multiple labels from one group
  • If there're no labels, issue wasn't reviewed yet

Issue types

Label Open 🔎 Closed 🔎 Description
bug search search Confirmed bugs
enhancement search search Requests for enhancement

Issues components

Label Open 🔎 Closed 🔎 Description
pythonista search search Pythonista application itself (UI, editor, console, ...)
internal-module search search Pythonista specific modules (ui, console, ...)
3rd-party-module search search Bundled 3rd party modules minus internal modules
documentation search search Documentation and examples

Issue priorities

Label Open 🔎 Closed 🔎 Description
crash search search Pythonista crashes
major search search Serious issue, no workarounds, ...
normal search search This isn't actually a label, any issue without major, minor or crash labels is considered as an issue with normal priority
minor search search Nice to have feature