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

Make the app modular, add in-code documentation, add formatting standards #16

Closed
amalnanavati opened this issue Apr 16, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@amalnanavati
Copy link
Contributor

Although the 2023 web app we've been working on (2023PreDeployment branch) has a functioning UI, it has several process issues:

  • Nested branches that go several layers deep.
  • Multiple people pushing code to the same branch.
  • No formal PR / code review process.
  • Lack of in-code documentation.
  • Large functions/components that should be split up.
  • Copy-pasted code.
  • Lack of a consistent style.

This is not anyone's fault, because when we were initially developing the web app we saw it as a small component of the overall feeding system. But the web app is will now be the central hub that users will use to interact with the system. Hence, it is crucial to have high quality code for the web app, and a process to ensure the code stays high quality.

This issue is for making the app modular, adding in-code documentation, adding formatting and style standards, and generally making the app easier for new folks to onboard onto and multiple folks to work on at once.

@amalnanavati amalnanavati self-assigned this Apr 16, 2023
@amalnanavati amalnanavati mentioned this issue Apr 16, 2023
2 tasks
@amalnanavati amalnanavati added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 16, 2023
@amalnanavati
Copy link
Contributor Author

Closed with #5 getting merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant