Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/getting started #161

Open
wants to merge 11 commits into
base: dev
Choose a base branch
from
Open

Docs/getting started #161

wants to merge 11 commits into from

Conversation

Pierre-Alexandre35
Copy link

@Pierre-Alexandre35 Pierre-Alexandre35 commented Aug 12, 2021

Make sure you have checked all steps below.

Issue

  • Added additional informations on how to run this program

Description

  • Added minimum Python version required (3.8)
  • Added one instruction after creating the virtualenv --> export PYTHONPATH=.

Tests

  • No testing

Commits

  • I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body explains "what" and "why", not "how"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain docstrings that explain what it does

Pierre added 2 commits August 12, 2021 09:50
… the program (not possible if you have Python < 3.8 and also add a some instructions to run the program
… the program (not possible if you have Python < 3.8 and also add a some instructions to run the program
@Pierre-Alexandre35
Copy link
Author

Je viens de fixer le job "lint with flake8" je regarde actuellement pour fixer le job "test with nose"

@bibimorlet
Copy link
Contributor

@Pierre-Alexandre35 Bien vu! Des erreurs de tests sont visiblement passées lors de PR récentes, c'est bien de les corriger dès maintenant, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants