py4dstem / py4dstem/py4DSTEM

v15 - Dev workflows and tools

Open
#624 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

v15
Dominant language
Python
Stars
279
Forks
177
PR merge metrics
No merged PRs in 30d

Description

Determine which CI/CD, linters and Dev tools to use and standardise the config

Improve dev experience and standardise code formatting, etc.

  • scope which tools, actions etc. we want to use
  • standardise where config files live, .github, top level or config
  • decide on flake8/ruff rule set
  • flake8 config file

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing CI/CD, linter, and developer-tool configuration, including possible locations in .github, the repository top level, and a config directory. Identify the tools and actions to standardise, decide the flake8/ruff rule set, and define the final configuration locations; done means these choices and the resulting configuration are documented and consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, devops, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.