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

Add section to Developer's Guide to provide guidance on code structure #42

Open
glemieux opened this issue Jul 27, 2023 · 0 comments
Open
Labels
enhancement Feature that improves the function of the guide outside of content

Comments

@glemieux
Copy link
Collaborator

glemieux commented Jul 27, 2023

Is your feature request related to a problem? Please describe.
While we have a style guide for providing guidance on formatting details, we don't provide guidance on how to structure new code additions (e.g. explaining why certain modules live where they do and where to place new modules).

Describe the solution you'd like
Add a new section under "Overview" containing multiple headings to address the following:

  • fates directory structure and module placement
  • where to place named constants (EDParams vs. FatesConstants vs. ?)
  • when to develop a new type or add to an existing type
  • passing as arguments versus "using"
  • etc.

Describe alternatives you've considered
I considered that we could add this to the style guide, but I think its a larger issue than style. If the concept being address is significantly large enough, we could give it a subsection of it's own.

Additional context
This was inspired by @adrifoster work on NGEET/fates#1024 which refactors the code structure.

@glemieux glemieux added the enhancement Feature that improves the function of the guide outside of content label Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature that improves the function of the guide outside of content
Projects
None yet
Development

No branches or pull requests

1 participant