Billingegroup / cookiecutter

A cookie-cutter for DiffPy packages.
Other
0 stars 7 forks source link

Refactor full_name -> github_org #42

Closed Sparks29032 closed 3 weeks ago

Sparks29032 commented 3 weeks ago

Do not change the workflow files as it is not using the cookiecutter full_name but the GitHub full_name.

Closes #40 as all other names seem fine.

sbillinge commented 3 weeks ago

full_name is used:

  1. in authors -> replace with "Billinge Group. See Github contributions for details"
  2. license -> replace with "Trustees of Columbia....."
  3. setup.py (and maybe pyproject.toml), same as 1.?
  4. doc/.../conf.py, same as 1.?

In that case we don't need to ask this question any more...

sbillinge commented 3 weeks ago

email is used:

  1. AUTHORS.rst. I suggest we handle it as 1. above. ACtually, since we want to be inclusive, maybe we should say "Billinge Group members and community contributors. See Github contributions <link?> for details". Getting the link right might be hard but doable. Let's not lose sleep over it.
  2. author_email = email in setup.py. Replace with sb2896@columbia.edu?

In which case we don't need to ask this question?

sbillinge commented 3 weeks ago

github_username is used:

  1. setup.py (possibly pyproject.toml) as the org in the github url. This seems to be an error that will be fixed, as it should be github_org in there not username
  2. CONTRIBUTING.rst in 2 GH URLs and a TRAVIS one (that will presumably be cleaned out). Deal with same way as above.
  3. badges in README.rst. See above. presumably will get fixed.

Summary: We need a question github_org that we don't have atm (except in this PR) but we don't actually need a question for github_username

sbillinge commented 3 weeks ago

I think the others are all fine as they are, though we can make it less confusing for people if we ask fewer questions because we are sticking to conventions of building directory names from package names and so on.

Sparks29032 commented 3 weeks ago

Got it, that makes sense

Sparks29032 commented 3 weeks ago

Okay, so I will remove email (and have made a comment in the setup.py issue about changing to your email). I also agree that github_username can be removed. I will keep full_name (refactored to github_org) as it will also be used to link to the contributor graph.

sbillinge commented 3 weeks ago

can we also get it down to just one question for package_name? Are there any edge cases where we will not use package_name for directory names and so on?

Sparks29032 commented 3 weeks ago

Not sure, it probably is there to ensure proper naming conventions for the package (for pip installation) and some command line commands that do not allow for spaces within names.

I want to at least keep dist name as maybe we want to release programs in the diffpy package without the diffpy. proceeding it. Not sure if this will ever happen, but maybe good to keep in case.

Sparks29032 commented 3 weeks ago

New header in __init__.py with contributors.

image

Sparks29032 commented 3 weeks ago

Can we merge this? I want to get the name change asap as the header files in all other .py files require github_org for the contributors.