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

Added Project Structure in README #273

Closed

Conversation

siri-chandana-macha
Copy link

Description

I have added the Project Structure to the README . This guides contributors on where specific files and folders are located and what they contain.

Related Issue

Fixes #271

Note: @multiverseweb please make sure to add all the necessary labels in #271

Copy link
Contributor

github-actions bot commented Nov 3, 2024

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

Copy link

netlify bot commented Nov 3, 2024

Deploy Preview for multiverse-dataverse ready!

Name Link
🔨 Latest commit bb3743e
🔍 Latest deploy log https://app.netlify.com/sites/multiverse-dataverse/deploys/672cb408ce7d5c00084512da
😎 Deploy Preview https://deploy-preview-273--multiverse-dataverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

🎉 Thank you for your contribution! Your pull request has been submitted successfully. A maintainer from Dataverse team will review it as soon as possible. We appreciate your support in making this project better

Copy link
Owner

@multiverseweb multiverseweb left a comment

Choose a reason for hiding this comment

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

@siri-chandana-macha you have added the structure in Readme file, which makes it long unnecessarily, also does this structure update automatically as many files will be added, deleted or renamed in future. Checkout the project structure in my other project, that is what should be done here too.

  • Give a link to the `project structure file in readme,md.
  • the structure should update automatically.

Good luck fixing the stated issue. You can ask if you have any doubts.

@siri-chandana-macha
Copy link
Author

siri-chandana-macha commented Nov 5, 2024 via email

@siri-chandana-macha
Copy link
Author

siri-chandana-macha commented Nov 5, 2024 via email

@siri-chandana-macha
Copy link
Author

@multiverseweb Yeah its long. I have added the Project Structure in a seperate file.

@siri-chandana-macha
Copy link
Author

There is a workflow for this right. I will update it

@jency1
Copy link
Collaborator

jency1 commented Nov 6, 2024

@siri-chandana-macha Resolve conflicts.

@siri-chandana-macha
Copy link
Author

@multiverseweb I tried to create workflow for project structure but it's not working so please consider this manually made one.

Copy link
Owner

@multiverseweb multiverseweb left a comment

Choose a reason for hiding this comment

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

Hey @siri-chandana-macha, the automated workflow has been added in the PR #313, therefore I can't merge this manual structure as changes will be made in the project structure continuously.

I hope you understand. Let me know if you want to discuss this further.

Good luck!

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.

[Doc]: Adding a Project Structure Map
3 participants