Development Practices Section #221
Description
This is an outline of a Development Practices section of the Sparkbox Standard intended to document development practices at Sparkbox. See DPTF Standard Outline for more information. Please feel free to work on any of the subsections or add new ones. These subsections include, but are not limited to the ones listed below and can be broken down further based on availability and interest.
- Introduction
- Values
- Patterns
- Principles
- Naming conventions
- Software Testing (already broken down since this is a big topic)
- Code refactoring
- Type checking
- Debugging
- Error handling
- Code documentation
Introduction
Scope
- Overview of Development Practices
- Link to subsections
Values
Scope
- How do our Sparkbox values inform our development practices?
- What do we value about the software we build?
- Link to existing resources
Links
Patterns
Scope
- General programming patterns
- HTML
- CSS
- JavaScript
- Object-Oriented design patterns
- Functional programming patterns
- Link to internal/external resources
Scope
- HTML
- CSS
- JavaScript
- Link to existing resources
Principles
Scope
- General programming principles
- HTML
- CSS
- JavaScript
- Link to internal/external resources
Links
Naming conventions
Scope
- General guidelines
- How to/process/examples (HTML, CSS, JavaScript)
- Link to internal/external resources
Links
- https://github.com/sparkbox/standard/search?q=naming
- SCSS Class Naming Theory
- Pattern Libraries: Naming Conventions
- Server Naming Conventions
- All Code
- Slack Naming Convention
- Git Naming Branches
- Image File Naming
- Folder Structure & Filie Naming
Software testing
Scope
- Types of Testing (In progress, Yosevu)
- Unit Tests (In progress, Yosevu)
- Integration Tests
- End-to-end Tests
- Mocking (In progress, Yosevu)
- Test-driven Development (In progress, Yosevu)
- Testing and Code Refactoring
- Testing and Type checking
- Testing Tools and Automation
- Link to internal/external resources
Other topics
- Testing and Accessibility
- Testing and Linting
- Testing and Styles
- Testing and Security
- Testing and Performance
- Testing and Quality Assurance
- Mutation Testing (@jordanleven)
- Generative and Property-based Testing
Links
Code Refactoring
Scope
- Code smells
- Tools/techniques
- How to/process/examples (HTML, CSS, JavaScript)
- Link to internal/external resources
Type checking
Scope
- Tools/techniques
- How to/process/examples (JavaScript/TypeScript/Go?)
- Link to internal/external resources
Debugging
Scope
- Tools/techniques
- How to/process/examples (HTML, CSS, JavaScript)
- Link to internal/external resources
Links
- Problem solving
- Stack traces
Error handling
Scope
- Techniques (JavaScript)
- How to/process/examples (JavaScript)
- Link to internal/external resources
Links
- Error logging
- Progressive enhancement
Code Documentation
Scope
- General guidelines
- How to/process/examples (HTML, CSS, JavaScript)
- Link to internal/external resources