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

feat: contribute.md for fe #94

Merged
merged 2 commits into from
Sep 19, 2023
Merged

feat: contribute.md for fe #94

merged 2 commits into from
Sep 19, 2023

Conversation

chubetho
Copy link
Collaborator

No description provided.

@chubetho chubetho requested a review from twynb September 18, 2023 19:59
@chubetho chubetho self-assigned this Sep 18, 2023
Copy link
Owner

@twynb twynb left a comment

Choose a reason for hiding this comment

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

As explained in the comment, the structure does cover every folder, but i think it should focus on covering the most important files/entrypoints instead

@@ -83,7 +86,23 @@ Tests are situated in ``backend/tests``. Each module that has unit tests has its

### Front-End Structure

TODO
- **components**: This directory serves as a home for reusable UI components. All components placed here are automatically imported, simplifying their usage. If you're enhancing or creating user interface elements, this is where you'll focus your efforts.
Copy link
Owner

Choose a reason for hiding this comment

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

I think it'd be helpful to order this not by the different folders, but by "where do i look if i want to find this?" - as in, starting with the main entrypoint, then where that main entrypoint leads and then where that leads, similarly to how I did it in the back-end structure. As an example, the "public" folder is rarely going to matter while implementing things, but having a specific info about which file to look for for frequently edited stuff (like the ProjectItem page) would be helpful.

Copy link
Owner

@twynb twynb left a comment

Choose a reason for hiding this comment

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

LGTM now

@chubetho chubetho merged commit 5a5b921 into main Sep 19, 2023
1 check passed
@chubetho chubetho deleted the contribue_fe branch September 19, 2023 19:50
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.

2 participants