Skip to content
This repository has been archived by the owner on Aug 19, 2019. It is now read-only.

Latest commit

 

History

History
80 lines (68 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

80 lines (68 loc) · 3.07 KB

Contributing to Astolfo

Thanks for taking an interest in this awesome little project. We love to bring new members into the community, and can always use the help.

Important resources

Where to contribute

Good for beginners

  • Documentation! Usage, how to add support for a new app, etc.
  • Adding unit tests
  • Adding functional tests
  • Development tooling: pylint, tox, better use of pipenv, etc.

Major areas

  • Reverse engineering Netflix and various other apps
  • Design and architecture of the program (framework?)
  • Improving integration with Windows (service, etc.)
  • Improving distribution: installer, bundling, etc.

Getting started

  1. Create your own fork of the code through GitHub web interface (Here's a Guide)
  2. Clone the fork to your computer. This can be done using the GitHub desktop GUI , git clone <fork-url>, or the Git tools in your favorite editor or IDE.
  3. Create and checkout a new branch in the fork with either your username (e.g. "ghostofgoes"), or the name of the feature or issue you're working on (e.g. "openbsd-support"). Again, this can be done using the GUI, your favorite editor, or git checkout -b <branch> origin/<branch>.
  4. Sync pipenv: pipenv sync
  5. Install the package:
pipenv shell
pip install -e .
  1. Setup and run the tests:
pip install -U tox
tox
  1. Write some code! Git commit messages should information about what changed, and if it's relevant, the rationale (thinking) for the change.
  2. Follow the checklist
  3. Submit a pull request!

Code requirements

  • All methods must have type annotations
  • Must work on Python 3.6+
  • Try to match the general code style (loosly PEP8)
  • Be respectful. Memes, references, and jokes are ok. Explicit language (cursing/swearing), NSFW text/content, or racism are NOT ok.

Checklist before submitting a pull request

  • Update the CHANGELOG (For non-trivial changes, e.g. changing functionality or adding tests)
  • Add your name to the contributers list in the README
  • All tests pass locally
  • Pylint is happy

Bug reports

Filing a bug report:

  1. Answer these questions:
    • What version of Astolfo are you using?
    • What operating system and processor architecture are you using?
    • What version of Python are you using?
    • What did you do?
    • What did you expect to see?
    • What did you see instead?
  2. Put any excessive output into a GitHub Gist and include a link in the issue.
  3. Tag the issue with "Bug"

NOTE: If the issue is a potential security vulnerability, do NOT open an issue! Instead, email: ghostofgoes(at)gmail(dot)com

Features and ideas

Ideas for features or other things are welcomed. Open an issue on GitHub detailing the idea, and tag it appropriatly (e.g. "Feature" for a new feature).