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

Run configuration for the devserver supported by Jetbrains/Intellij IDEs #3665

Merged
merged 2 commits into from
Mar 18, 2023

Conversation

bjester
Copy link
Member

@bjester bjester commented Sep 21, 2022

Summary

Description of the change(s) you made

  • Adds run configuration that's needed for using in-IDE debugging capabilities of Jetbrains/Intellij IDEs

Manual verification steps performed

  1. Pull branch
  2. Open supported IDE
  3. You should have a run configuration called "devserver", shown in the screen shot
  4. Press the green play button
  5. Terminal should open and devserver should start

Screenshots (if applicable)

Screenshot from 2022-09-21 12-45-29

Comments

To debug, you press the bug looking icon next to the play icon


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@vkWeb
Copy link
Member

vkWeb commented Sep 22, 2022

@bjester just thinking whether we should also add this config file to gitignore so that personal config modifications aren't tracked by git?

@bjester
Copy link
Member Author

bjester commented Sep 22, 2022

@bjester just thinking whether we should also add this config file to gitignore so that personal config modifications aren't tracked by git?

@vkWeb So since it has already been added to git, now add it to the .gitignore? Yeah I think that might work like you said-- ignoring future changes. Including this as a project file is an optional setting in the IntelliJ IDEs. @rtibbles asked that I commit this, foremost to share it with our new colleagues using PyCharm but perhaps so we can also maintain it since it's a duplication of commands like yarn run runserver. It should only change if a developer explicitly edits the configuration through the IDE UI, so I'm not too worried about unintentional changes

@rtibbles
Copy link
Member

Yeah, adding it to the .gitignore seems like a way to prevent changes from being accidentally committed for local configuration. Can still force add ignored files to make updates, so it's a good way to make sure any such commits are completely intentional.

@vkWeb
Copy link
Member

vkWeb commented Mar 18, 2023

@AllanOXDi I think you use Jet Brains IDE? Please perform the manual verifications step mentioned in this PR to see if the settings are working as expected. Then, we can merge this in.

Copy link
Member

@AllanOXDi AllanOXDi left a comment

Choose a reason for hiding this comment

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

I ran manual verification steps and everything works perfectly. I think we are good to merge this.

@vkWeb vkWeb merged commit b842dd8 into learningequality:unstable Mar 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants