search

materialsproject / foundation

MIT License
17 stars 5 forks source link

Use .github repository to outline broad principles #13

Open shyuep opened 1 year ago

shyuep commented 1 year ago

I have created the Materials Project .github repository. This allows one to write a standard set of files, e.g., PR templates, Issue templates, a profile page (check out the MP organizational Github page). I suggest you use this to standardize common practices across ALL MP's repos. I have added pymatgen's templates as a default. I will leave it to MP folks to figure this out. @janosh has been made an admin for that repo and he can add whoever else needs access.

janosh commented 1 year ago

Great idea, thanks @shyuep! @utf How about we bring this up in the next foundation meeting to discuss how exactly we want to standardize issue/PR templates across MP repos?

janosh commented 1 year ago

Let's keep an eye on https://github.com/orgs/community/discussions/7926. I just added .github/release.yml to pymatgen.

Would be nice to standardize release note format across MP repos.

See pymatgen v2023.9.10 for what such a format might look like.

rkingsbury commented 1 year ago

Sounds like a good idea! Harmonizing all the packaging minutia would really streamline repo maintenance for all of us busy PIs. Note that I've been using pyscaffold as a reference point for many things (similar idea, but more general). Will be great to have an MP-specific repo template.

shyuep commented 1 year ago

The PR and Issue templates are completely standardized. This is a good thing because all of MP will ask for the same basic info when reporting bugs and feature requests.

The workflow templates in the .github repo are just templates. When someone sets up a new workflow in an MP repo, that template is then provided as an option to setup the workflow. Again, this is a good practice. It makes sure that all MP goes through the same basic steps for lining, testing, and release. Of course, it does nothing to enforce that tests are actually written or passes... that is up to the maintainer.