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

Unique package name - Corrective action steps #280

Merged
merged 4 commits into from
May 31, 2024

Conversation

pb-413
Copy link
Contributor

@pb-413 pb-413 commented May 21, 2024

I added the steps discussed in #244 to the documentation in a drop down section because these felt like optional steps and I saw this formatting used in another location in the tutorial.

I separated it into two lists, 'required' and 'recommended.' Not sure if that is a design decision in line with your vision.


Side note: Do we want to reiterate project naming guidelines? I know that during #261 I had issues including hyphens in my project name. You mention already in Make your code installable - Step 1: Set Up the Package Directory Structure that you may have a hyphen in the name of your project, but you then create the project with hatch which manages creating the module directory under source with an underscore instead. I don't think we want to re-create with hatch here, but raising spot where a user can trip in the tutorial and even with my new steps. We can add troubleshooting information to these steps or, what I would recommend, front load the "check that your name is available" work to before creating the project with hatch.

Copy link
Member

@lwasser lwasser left a comment

Choose a reason for hiding this comment

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

This is a great addition. Thank you so much @pb-413 !!

@lwasser
Copy link
Member

lwasser commented May 31, 2024

There was a small merge conflict that i cleaned out! we had a bunch of edits to this file. We can merge once CI is happy!

@lwasser lwasser merged commit af1c7e3 into pyOpenSci:main May 31, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

2 participants