GitHub community health files#127
Draft
ElenaFdR-ICATT wants to merge 7 commits into
Draft
Conversation
Contributor
|
This makes me think we might want a section for resources covering multiple requirements, and from there just link to those it covers. That way we only need to add it once but still get it connected to the requirements. However, this will be easy to miss for a reader diving into a specific requirement. |
Contributor
Author
|
For my employer, I'm working on a to-do list with guidance and templates when setting up a new repo based on the Foundation for Public Code's Product Assets and Community Assets checklists. It's currently localized to the Netherlands, but I can share a generic version when I'm finished? |
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.
This implements #123.
I'd like feedback on my approach. I've gone for completeness and added the Github instructions for adding a community health file to every criterion where the content fulfilling that criterion lives naturally in that file (example: a CONTRIBUTING could contain content on both coding style and how to group changes in commits).
But it results in potentially reduced readability, since the same or similar content is reproduced in multiple places. A different approach would be to link once to the file instructions in only the most relevant place, and trust the reader to work it out from there.
Thoughts?