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 #66

Closed
wants to merge 2 commits into from

Conversation

MAYANK12SHARMA
Copy link
Contributor

@MAYANK12SHARMA MAYANK12SHARMA commented Feb 28, 2025

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

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
1 participant