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

Refactor Repository Structure & Improve Contributor Onboarding #69

Merged
merged 3 commits into from
Mar 3, 2025

Conversation

MAYANK12SHARMA
Copy link
Contributor

Pull Request

Description

This PR aims to improve the repository structure and enhance the onboarding experience for new contributors.

  • Moved multiple README files from the root directory into a dedicated /docs folder for better organization.
  • Updated any relevant links or references to the relocated files.
  • Added a section in Maintainers.md to guide new contributors on setting up environment variables, making local development easier.

Fixes #65

How Has This Been Tested?

Since this change mainly affects documentation and structure, testing involved:

  • Verifying the folder structure and file paths.
  • Clicking through updated links to confirm they resolve correctly.
  • Reviewing the new environment setup instructions for accuracy and clarity.

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

@MAYANK12SHARMA
Copy link
Contributor Author

MAYANK12SHARMA commented Feb 28, 2025

Hi @peterdudfield, @jcamier Could you please take a moment to review the PR.

@MAYANK12SHARMA
Copy link
Contributor Author

MAYANK12SHARMA commented Feb 28, 2025

Ah! It’s good to see that both Checks have passed now.

@jcamier
Copy link
Collaborator

jcamier commented Mar 3, 2025

@MAYANK12SHARMA this looks great! I made a quick update to datasets today because we just finished a milestone on the datasets. Please update your repo to resolve the merge conflict. Thanks!

@MAYANK12SHARMA MAYANK12SHARMA reopened this Mar 3, 2025
@MAYANK12SHARMA
Copy link
Contributor Author

Hi @jcamier, thank you for your support! I’ve made the necessary changes, and there are no conflicts now. Please review the updates and feel free to merge. Thanks!

@MAYANK12SHARMA
Copy link
Contributor Author

I’d also like to know what the next milestone will be that the team will be working on.

@jcamier jcamier merged commit deaec8d into openclimatefix:main Mar 3, 2025
4 checks passed
@jcamier
Copy link
Collaborator

jcamier commented Mar 3, 2025

@MAYANK12SHARMA thanks. I just merged the PR.

@MAYANK12SHARMA
Copy link
Contributor Author

Thanks, @jcamier! I am trying to figure out other issue, are there any current issues I can work on?

@jcamier
Copy link
Collaborator

jcamier commented Mar 3, 2025

@MAYANK12SHARMA I need your email address to add you to slack.

@MAYANK12SHARMA
Copy link
Contributor Author

[email protected]

@MAYANK12SHARMA
Copy link
Contributor Author

Thank you so much @jcamier.

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.

Organize Document Files and Add Environment Setup Instructions in Maintainers.md
2 participants