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

Ediatable configs without risk of versioning + Getting started instructions in README #106

Merged
merged 2 commits into from
Dec 20, 2023

Conversation

confusedmatrix
Copy link
Contributor

Pull Request

Description

  • Moves the existing default configs to configs.example directory
  • Users are now expected to copy this to configs directory (which is gitignored to prevent versioning)
  • Adds instructions for new users to PVNet to help get up and running, including advice on sourcing datasets for use with PVNet

How Has This Been Tested?

Ran through new instructions from scratch to ensure accuracy

  • Yes

If your changes affect data processing, have you plotted any changes? i.e. have you done a quick sanity check?

  • Yes

Checklist:

  • My code follows OCF's coding style guidelines
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked my code and corrected any misspellings

@confusedmatrix confusedmatrix linked an issue Dec 14, 2023 that may be closed by this pull request
Copy link

codecov bot commented Dec 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fe30469) 50.85% compared to head (48a282a) 50.85%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #106   +/-   ##
=======================================
  Coverage   50.85%   50.85%           
=======================================
  Files          26       26           
  Lines        1701     1701           
=======================================
  Hits          865      865           
  Misses        836      836           

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

@peterdudfield peterdudfield requested a review from dfulu December 20, 2023 10:54
@peterdudfield
Copy link
Contributor

@dfulu can you have a look at this?

Copy link
Member

@dfulu dfulu left a comment

Choose a reason for hiding this comment

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

Looks great @confusedmatrix! Thanks for doing this

@dfulu dfulu merged commit 416daec into main Dec 20, 2023
5 checks passed
@dfulu dfulu deleted the chris/editable-configs branch December 20, 2023 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add placeholders to configs
3 participants