Skip to content

Conversation

jhaigh0
Copy link
Contributor

@jhaigh0 jhaigh0 commented Nov 20, 2024

Description of work

Add instructions for creating custom mantid-developer package to Packaging.rst

There is no associated issue.

To test:

Follow instructions to test. Use conda list in your new environment to check the correct changes were made.

Docs build with good formatting.

This does not require release notes because change to dev docs


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@jhaigh0 jhaigh0 added Documentation Issues and pull requests related to documentation ISIS: Core Issue and pull requests at ISIS that relate to Core features and functions labels Nov 20, 2024
@jhaigh0 jhaigh0 added this to the Release 6.12 milestone Nov 20, 2024
@jclarkeSTFC jclarkeSTFC self-assigned this Nov 21, 2024
Copy link
Contributor

@jclarkeSTFC jclarkeSTFC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a couple of typos. It will be very useful to have these instructions in the docs.

@jhaigh0 jhaigh0 force-pushed the add_custom_mantid_developer_instructions branch from bfbde42 to e6bc36b Compare November 21, 2024 09:42
@rbauststfc rbauststfc self-assigned this Nov 22, 2024
@rbauststfc rbauststfc merged commit adb07df into main Nov 22, 2024
10 checks passed
@rbauststfc rbauststfc deleted the add_custom_mantid_developer_instructions branch November 22, 2024 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation ISIS: Core Issue and pull requests at ISIS that relate to Core features and functions
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants