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 PR code review guidelines to the CONTRIBUTING doc #2285

Closed
robyngit opened this issue Feb 29, 2024 · 0 comments · Fixed by #2287
Closed

Add PR code review guidelines to the CONTRIBUTING doc #2285

robyngit opened this issue Feb 29, 2024 · 0 comments · Fixed by #2287
Assignees
Labels
documentation Creating and enhancing app documentation enhancement
Milestone

Comments

@robyngit
Copy link
Member

Document code guidelines for submitting a PR. These are aspects of changes that will be checked for during code review:

  • Make sure to test your changes across all themes shipped with MetacatUI (like arctic, dataone, default, knb), and also the themes in the metacatui-themes repo (like drp and sctld).
  • Check how your changes perform on various screen sizes.
  • If you’re tweaking an existing model, collection, or view, please review where that component is used elsewhere in MetacatUI to ensure there’s no unintended impact on those functionalities (especially since our testing coverage is not comprehensive yet).
  • Make sure changes don’t slow down MetacatUI even more.. especially if the PR involves big additions.
  • Check for robust error handling and user-friendly error messages.
  • If the PR adds or updates dependencies, are they are necessary or do they add bloat the project? Is it redundant with other dependencies? Can we use a more lightweight alternative? Try to choose dependencies that have a long history and big backing community to increase the chances of them being maintained long-term.
  • If applicable, verify the functionality of your changes for both signed-in and non-signed-in users.
  • In addition to the JSDocs, if your changes impact something in the docs/guides, update those. If it’s a big feature that requires configuration by those running MetacatUIs, add a new guide.
  • Make sure security implications are considered and addressed.
@robyngit robyngit added enhancement documentation Creating and enhancing app documentation labels Feb 29, 2024
@robyngit robyngit added this to the 2.28.0 milestone Feb 29, 2024
@robyngit robyngit self-assigned this Feb 29, 2024
robyngit added a commit that referenced this issue Feb 29, 2024
And note how to get in touch with team for questions about contributing.

Issue #2285
@robyngit robyngit linked a pull request Feb 29, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Creating and enhancing app documentation enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant