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 documentation on how to get a PR merged #280

Closed
sbryngelson opened this issue Dec 27, 2023 · 1 comment
Closed

Add documentation on how to get a PR merged #280

sbryngelson opened this issue Dec 27, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@sbryngelson
Copy link
Member

Tracking item for adding documentation on how to get a PR merged.

  • Performance

    • GPU and CPU wall clock times with and without the new feature
    • Weak scaling with the new feature
  • Documentation

    • Doxygen (SHB: add link to syntax)
  • Tests

    • Add relevant tests to the test suite (SHB: add link on how to do that)
  • Checks

    • Add checks to the appropriate codes (preprocess, simulation, postprocess) in m_checker to be sure incompatible features are not used
  • Code quality

    • Code should not be longer than is required (in, say, line count)
    • Comments that are really personal notes-to-self should be removed
@sbryngelson sbryngelson added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 27, 2023
@sbryngelson sbryngelson self-assigned this Dec 27, 2023
@sbryngelson
Copy link
Member Author

closed via #337

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Development

No branches or pull requests

1 participant