Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
arlo/docs/contribution-guidelines.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
37 lines (19 sloc)
1.07 KB
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
# Contribution Guidelines | |
When making a Pull Request, make sure to run through the following checklist: | |
_Function_ | |
[] Code is fully functional and ready for review (or is tagged WIP) | |
[] No errors/warnings in the browser console ( ゚ヮ゚)/ | |
[] package.json is committed if I added or removed any dependencies | |
[] Tests added as needed to ensure code base still has 100% passing coverage | |
[] Tests added as needed to cover new functionality | |
_Style_ | |
[] Passes linter without errors | |
[] Code is easily understandable and self-documenting (using naming conventions in keeping with the rest of the codebase) | |
[] Interfaces all have 'I' before their names (as in `IAudit`) | |
[] Comments are only included as needed to explain the 'why' instead of the 'what' | |
[] Common standards and coding practices are adhered to | |
[] DRY: Don't Repeat Yourself. Code is reasonably structured to avoid repetition | |
[] Code is intuitively structured following a Separation of Concerns | |
[] No class components; only functional components (using Hooks as needed) | |
_Workflow_ | |
[] Do an interactive rebase or a rebase |