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

Update jdaviz developer installation instructions #2569

Merged
merged 2 commits into from
Nov 16, 2023

Conversation

gibsongreen
Copy link
Contributor

@gibsongreen gibsongreen commented Nov 15, 2023

Description

In installation.rst, the order of development install instructions have been changed (primarily to move the editable environment to the last step). The addition of IPython magic commands were included as an optional suggestion for developers, and a brief description to code contribution instructions (hyperlink to astropy instructions) was added so a new developer can briefly understand what is hyperlinked; and a general suggestion to virtual environments is now suggested.

Original Instructions
original_dev_instruct
Updated Instructions
updated_dev_instruct

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

…ython magic commands, and added description to code contribution section
@github-actions github-actions bot added the documentation Explanation of code and concepts label Nov 15, 2023
@gibsongreen gibsongreen changed the title Update jdaviz Developer Installation Instructions Update jdaviz developer installation instructions Nov 15, 2023
@pllim pllim added this to the 3.8 milestone Nov 15, 2023
@kecnry kecnry added the no-changelog-entry-needed changelog bot directive label Nov 15, 2023
@pllim pllim added the trivial Only needs one approval instead of two label Nov 15, 2023
@kecnry
Copy link
Member

kecnry commented Nov 15, 2023

Should we also include advice that it is necessary to install without -e first to copy the template files?

Copy link

codecov bot commented Nov 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5b45ba7) 90.87% compared to head (58b56a9) 90.82%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2569      +/-   ##
==========================================
- Coverage   90.87%   90.82%   -0.05%     
==========================================
  Files         160      160              
  Lines       19388    19388              
==========================================
- Hits        17618    17609       -9     
- Misses       1770     1779       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gibsongreen
Copy link
Contributor Author

Should we also include advice that it is necessary to install without -e first to copy the template files?

Yes that sounds like a good idea to me

Copy link
Member

@kecnry kecnry left a comment

Choose a reason for hiding this comment

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

Works for me - thanks!

Rendered docs can be previewed here.

@pllim pllim merged commit ac3078a into spacetelescope:main Nov 16, 2023
18 of 19 checks passed
@pllim
Copy link
Contributor

pllim commented Nov 16, 2023

Thanks and congrats on your first PR!

rosteen pushed a commit to rosteen/jdaviz that referenced this pull request Nov 29, 2023
* In installation.rst, changed the order of dev install steps, added IPython magic commands, and added description to code contribution section

* Added a note to install first without -e flag to obtain template files

---------

Co-authored-by: Gilbert Green <ggreen@tapangalia2023.local>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive Ready for final review trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants