Create readme_template.md #1271
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
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.
GitHub Issue: #1268 and #1267
What does this Pull Request do?
Adds a document describing a template to follow for setting up readmes in Islandora 8 GitHub repos. Based heavily on the existing template for Islandora 7.
What's new?
New .md file in the contributing section of the documentation.
How should this be tested?
Test by previewing the document - but I'm also looking for evaluation of the format itself. Is this a good template/ Are there sections we should add?
Additional Notes:
This could be done as a page in the github wiki, like it is for 7.x, but then there's no PR process for review.
Interested parties
@Islandora-CLAW/committers because this will hit every repo