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

Cookiecutter #6

Merged
merged 10 commits into from
Jul 24, 2024
Merged

Cookiecutter #6

merged 10 commits into from
Jul 24, 2024

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented Jul 23, 2024

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • CHANGELOG.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Finalizes the cookiecutter template needed to begin development

Does this PR introduce a breaking change?

No.

Other information:

Refer to https://github.com/Ouranosinc/cookiecutter-pypackage

Numpydoc was disabled due to issue with their CLI on conda and PyPI (pre-commit hooks work as intended).

@Zeitsperre Zeitsperre requested a review from coxipi July 23, 2024 18:16
Copy link

github-actions bot commented Jul 23, 2024

Welcome, new contributor!

It appears that this is your first Pull Request. To give credit where it's due, we ask that you add your information to the AUTHORS.rst and .zenodo.json:

  • The relevant author information has been added to AUTHORS.rst and .zenodo.json.

Please make sure you've read our contributing guide. We look forward to reviewing your Pull Request shortly ✨

@Zeitsperre Zeitsperre self-assigned this Jul 23, 2024
@Zeitsperre Zeitsperre added the priority Immediate action required label Jul 23, 2024
@Zeitsperre
Copy link
Contributor Author

@coxipi This is ready for final review and merge.

I'll tag a v0.1.0 release once this PR is merged.

@@ -29,7 +33,7 @@ on:
- pyproject.toml
- tests/**.py
- tox.ini
- xsdba/__init__.py
- src/xsdba/__init__.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused about the change, since it's a whole new repo. Is this something about CookieCutter previously not respecting this structure with src/...?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first commit was a generic Github template, and now you're applying your own CookieCutter template?

Copy link
Contributor Author

@Zeitsperre Zeitsperre Jul 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a lot of moving parts and sometimes I forget to add certain files. The src structure is relatively new, and I'm still moving the template over to it, so it seems.

I'll probably be pushing one more change (the issue about numpydoc that I raised is fixed). I'll merge soon after!

Copy link
Contributor

@coxipi coxipi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, although I have very low knowledge on this.

@Zeitsperre Zeitsperre merged commit ea4f19d into main Jul 24, 2024
16 checks passed
@Zeitsperre Zeitsperre deleted the cookiecutter branch July 24, 2024 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority Immediate action required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate boilerplate with cookiecutter-pypackage
2 participants