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

Make the repository Scientific Python compliant #187

Closed
Saransh-cpp opened this issue Sep 10, 2024 · 3 comments
Closed

Make the repository Scientific Python compliant #187

Saransh-cpp opened this issue Sep 10, 2024 · 3 comments
Assignees
Labels
infrastructure Project infrastructure: dev tools, packaging, etc. maintenance Maintenance: refactoring, typos, etc.

Comments

@Saransh-cpp
Copy link
Member

See https://learn.scientific-python.org/development/guides/repo-review/?repo=glass-dev%2Fglass&branch=main for all the missing things. Not all of them must be added, but most of them should be.

@Saransh-cpp Saransh-cpp added infrastructure Project infrastructure: dev tools, packaging, etc. maintenance Maintenance: refactoring, typos, etc. labels Sep 10, 2024
@Saransh-cpp Saransh-cpp self-assigned this Sep 10, 2024
paddyroddy pushed a commit that referenced this issue Sep 12, 2024
XRef #187 

Reviewed-by: Patrick J. Roddy <[email protected]>
Reviewed-by: Nicolas Tessore
Saransh-cpp added a commit that referenced this issue Sep 18, 2024
Adds several misc `pygrep` hooks recommended by scientific python.

Refs: #170, #187
paddyroddy added a commit that referenced this issue Sep 18, 2024
Adds several misc `pre-commit-hooks` recommended by scientific python.

Refs: #170, #187

---------

Co-authored-by: Patrick J. Roddy <[email protected]>
Saransh-cpp added a commit that referenced this issue Sep 18, 2024
The developers will now be able to download wheels as artifacts from GH
Actions without actually publishing a release. This helps in checking if
everything is working well or if you want to distribute a pre-release
wheel. Anyways, it is a good practice to keep these 2 jobs separate.

Closes: #176
Refs: #187
paddyroddy pushed a commit that referenced this issue Sep 18, 2024
I have already enable `pre-commit.ci` in the repository settings. This
just adds a pretty PR title layer over the bot.

Closes: #234
Refs: #187

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
paddyroddy added a commit that referenced this issue Sep 25, 2024
Add blacken-docs for formatting of documentation files.

Refs: #170, #187

---------

Co-authored-by: Patrick J. Roddy <[email protected]>
@Saransh-cpp
Copy link
Member Author

This can be closed now. The only failing checks from repo-review are -

  1. PY007: Supports an easy task runner (nox or tox)
    We don't want this as our testing infrastructure is simple enough.
  2. GH212: Require GHA update grouping
    Getting rid of dependabot in Consider @renovatebot instead of @dependabot #174
  3. PC140: Uses a type checker, MY100: Uses MyPy (pyproject config), and related checks...
    Being tracked in Add mypy for type checking #280 and Use numpy.typing instead of numpy.ndarray #246
  4. PC160: Uses a spell checker
    We don't want one permanently in our repository.

@paddyroddy
Copy link
Member

paddyroddy commented Sep 25, 2024

This can be closed now. The only failing checks from repo-review are -

  1. PY007: Supports an easy task runner (nox or tox)

We don't want this as our testing infrastructure is simple enough.

I'm not sure if I agree with this, tox is very simple to set up (not used nox myself). But I agree it is not urgent either way.

@Saransh-cpp
Copy link
Member Author

I can create an issue for this for later.

Saransh-cpp added a commit that referenced this issue Sep 25, 2024
Add blacken-docs for formatting of documentation files.

Refs: #170, #187

---------

Co-authored-by: Patrick J. Roddy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Project infrastructure: dev tools, packaging, etc. maintenance Maintenance: refactoring, typos, etc.
Projects
None yet
Development

No branches or pull requests

2 participants