elixir-cloud-aai / foca

Opinionated Flask microservice archetype for quick OpenAPI-based microservice development
Apache License 2.0
16 stars 12 forks source link

build: make project PEP 561 compliant #192

Closed Rahuljagwani closed 11 months ago

Rahuljagwani commented 11 months ago

Description

Fixes #187

Type of change

Checklist:

codecov[bot] commented 11 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (2c89ba8) 100.00% compared to head (61d754a) 100.00%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #192 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 20 20 Lines 984 984 ========================================= Hits 984 984 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

Rahuljagwani commented 11 months ago

I am not able to get it. When I pushed the commit, the pet store tests failed as one of the statements was DOCKERHUB_ORG:. But in other PR tests, the same statement comes as: DOCKERHUB_ORG: ***. Link. Am I doing something wrong? @uniqueg

uniqueg commented 11 months ago

You still created the pull request from your fork.

Instead, what you should do is:

  1. Clone the repo and move inside the directory:
    git clone https://github.com/elixir-cloud-aai/foca.git
    cd foca
  2. Then create a "feature branch" with:
    git checkout -b "pep561"
  3. Apply your changes.
  4. Stage files, commit and push:
    
    git add setup.py py.typed
    git commit -m "build: make project PEP 561 compliant"
    git push origin pep561
  5. Finally, come back to the repo and create a new pull request.
Rahuljagwani commented 11 months ago

You still created the pull request from your fork.

Instead, what you should do is:

  1. Clone the repo and move inside the directory:
    git clone https://github.com/elixir-cloud-aai/foca.git
    cd foca
  2. Then create a "feature branch" with:
    git checkout -b "pep561"
  3. Apply your changes.
  4. Stage files, commit and push:
    git add setup.py py.typed
    git commit -m "build: make project PEP 561 compliant"
    git push origin pep561
  5. Finally, come back to the repo and create a new pull request.

Thanks a lot @uniqueg, created PR #193 (finally all checks have passed). Do we need to mention the above steps in developer documentation orCONTRIBUTING.md for new contributors?