Show contributors #45
Merged
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
- This uses the github commits API. A guide 'contributor' is classified as someone other than the original author that shows up in the commits as an 'author' i.e. they've contributed at least 1 line to the guide itself. - Note this doesn't handle pagination for the commit API yet so the contributors list only reflects data from the most recent 30 commits to a guide. - Related to #34
- The commit history can include an author multiple times. Sometimes that history can have the author's full name and login and other times it can only include login. This change makes sure we don't ever count a user as a contributor more than once regardless of whether there were commits with and without their real name. - Also changed contributors property to return a list of tuples instead of a list of User objects, which will make it easy to serialize and cache.
… text - This effectively makes sure we cache the guide with the list of contributors when showing published guide pages.
|
Need to handle pagination of commits via the API. |
|
This PR addresses this issue. |
- The metadata is meant as peristent storage for things that do not change very often. The list of contributors can change often and that information is already persistent in the commit history.
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.
No description provided.