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

Implement CI and coding standards #5

Closed
jatkinson1000 opened this issue Feb 16, 2023 · 4 comments · Fixed by #15
Closed

Implement CI and coding standards #5

jatkinson1000 opened this issue Feb 16, 2023 · 4 comments · Fixed by #15
Assignees
Labels
code review Resulting from Feb 2023 code review enhancement New feature or request

Comments

@jatkinson1000
Copy link
Member

Add a CI framework for code and select standards to run to.

black
pylint
mypy
pydocstyle numpy convention

@jatkinson1000 jatkinson1000 added the enhancement New feature or request label Feb 16, 2023
@jatkinson1000
Copy link
Member Author

jatkinson1000 commented Feb 16, 2023

I started work on this in the cleanup branch, but this should probably do in it's own branch to tackle this issue.

@raehik can possibly add in pytest functionality when addressing #6

@raehik
Copy link
Contributor

raehik commented Feb 16, 2023

For reference, here's an example CI config with the on key highlighted. Runs the workflow on every push to main, and various actions to any pull request targeting any branch: raehik/strongweak/.github/workflows/ci.yml

on:
  push:
    branches:
    - main
  pull_request:
    types:
    - synchronize
    - opened
    - reopened

@jatkinson1000
Copy link
Member Author

There seems to be a pre-commit app being run as part of actions/CI.
Do we want to keep this, and if so how should it be set up?
Currently raises failures on opening PRs, and it can probably be implemented as part of the other CI.

@raehik
Copy link
Contributor

raehik commented Feb 16, 2023

in a quick meeting @arthurBarthe suggested interest in having linting done by pre-commit.ci. xGCM do this. Though it won't run on a free private repo (either needs to be public, or paid).

@jatkinson1000 jatkinson1000 self-assigned this Feb 20, 2023
@jatkinson1000 jatkinson1000 linked a pull request Feb 20, 2023 that will close this issue
5 tasks
@jatkinson1000 jatkinson1000 added the code review Resulting from Feb 2023 code review label Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code review Resulting from Feb 2023 code review enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants