refactor: split views, reorganize CSS, add docs for new contributors#437
Open
refactor: split views, reorganize CSS, add docs for new contributors#437
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Structural refactor to make the codebase easier for new organizers. No logic changes, only code moved around hehe.
Views splitting
Six monolithic
views.pyfiles converted toviews/packages, split by feature concern:organizerslists.py,review.py,batch_ops.pyapplicationshacker.py,mentor.py,sponsor.py,draft.pyreimbursementhacker.py,organizer.pyuserauthentication.py,profile.pybaggagehacker.py,volunteer.pyhardwarehacker.py,admin.pyCSS reorganization
custom-bootstrap.css(was 1.5k lines) split into 14 component files underapp/static/css/bootstrap-overrides/main.cssintostats/static/css/stats.cssandorganizers/static/css/organizers.cssDocumentation
New
docs/folder with four guides for new webdev organizers:docs/getting-started.md— what the app does, app-by-app overview, URL map, where templates and styles livedocs/setting-up.md— local dev setup (extracted from README)docs/contributing.md— worked examples for the most common yearly changes (add/remove a form field, change the reimbursement cap)docs/email-templates.md— full table of every email the system sends, how to edit content and subjects, how to add template variables