NWChemEx / .github

GitHub Settings for the NWChemEx Organization
https://nwchemex.github.io/.github/
Apache License 2.0
1 stars 2 forks source link

Developer Notes on Repo Layouts #85

Closed ryanmrichard closed 1 year ago

ryanmrichard commented 1 year ago

PR Type

Brief Description

In preparing ParallelZone's developer documentation I had put some notes together explaining what the various directories and files were. I then realized that most of our repos are set up in the same way so it probably makes more sense for that documentation to live here.

Not In Scope

I didn't go into full details of how the include/, src/, and tests/ directories should be structured. If we want to hammer that out now we can, and I'll update the PR. Otherwise, we can tackle that at a later point in time.

PR Checklist

ryanmrichard commented 1 year ago

This PR also shortens the link list in the PR templates and creates a new developer topic "conventions" (which also subsequently required some refactoring to bring all the conventions together).

ryanmrichard commented 1 year ago

🚀 [bumpr] Bumped! New version:v0.1.0 Changes:v0.0.10...v0.1.0