Best Practices #34
Merged
Best Practices #34
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
- Add Best Practices document - Add PR template - Update Contributing document with latest updates
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 PR adds the Best Practice document, a PR template, and updates the Contributing document with the latest updates.
This Best Practice document removes the coding practices around self-explanatory code (since this is pretty much just FSH examples, not code), unit tests, lint, and prettier (since all 3 do not exist in this repo). I did add two best practices around contributing examples:
It also removes the mention of updating FSH School documentation since that isn't applicable to this repo.
I also removed the "Testing Instructions" section of the PR template since contributions will likely just need to review the FSH added, so there likely aren't many other testing instructions needed.