[skip ci] add initial draft of contribution filtering doc #902
Conversation
This file contains 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
solebared
approved these changes
Mar 12, 2021
Comment on lines
36
to
37
| * * turns the filtered list of contributions into the format that the Browse page accepts | ||
| * * accepts some options that allow us to conditionally change what shows up (we expect this to help with user authorization features or system configuration features) |
There was a problem hiding this comment.
Did you want these two points to be indented under the one above?
maebeale
approved these changes
Mar 20, 2021
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.
Why
The filtering code provides us a nice level of flexibility in adding new features. As a tradeoff, it's now harder to understand
What
Added a markdown document to describe the key parts of the architecture of how we sort and filter contributions for display in the Vue.js code. The description here should be fairly accurate for both the current code base and the proposed changes in #546
How
Next Steps
I'd like to finish #546
Outstanding Questions, Concerns and Other Notes
Please suggest edits!
Accessibility
Hopefully this makes our code easier to understand
Security
Security concerns are not discussed in this document
Pre-Merge Checklist