Vets Who Code Engineering SOPs and Field Manual ποΈ¶
"Proper Planning and Preparation Prevents Poor Performance" - Military Leadership Principle
Core Values: Our Guiding Principles πΊπΈ¶
Our military service instilled values that continue to guide us as software engineers:
1. Integrity First¶
- Write clear, maintainable code that reflects its intended purpose
- Own your mistakes and learn from them
- Practice radical transparency in your work
- Give credit where credit is due
- Document truthfully and thoroughly
2. Service Before Self¶
- Your code impacts the entire team and community
- Build solutions that benefit the whole organization
- Support the developer community through open-source contributions
- Put user needs at the forefront of development decisions
- Mentor and support your fellow veterans
3. Excellence In All We Do¶
- Commit to continuous improvement
- Regularly evaluate and enhance your code
- Stay current with industry best practices
- Share knowledge to elevate the entire team
- Maintain high standards in all deliverables
Goal¶
To provide a comprehensive field manual that:
- Guides veterans through their software engineering journey
- Standardizes project documentation and processes
- Serves as a quick-reference technical guide
- Maintains operational readiness through best practices
- Fosters a culture of collaboration and knowledge sharing
- Upholds the core values of Integrity, Service, and Excellence
- Empowers veterans to succeed in the tech industry
- Supports the Vets Who Code community
- Encourages contributions and feedback from all members
Field Manual: The Playbooks π¶
The field manual is built as the Hashflag Software Engineering Playbooks β a leveled path from your first command in the terminal to shipping production AI. Start with the Overview, then work the tracks in order:
- Foundations β the shared base every engineer stands on: terminal, VS Code, Git, HTML & CSS, JavaScript, Python, advanced Python, the SDLC, and code challenges.
- Next.js β the frontend and full-stack track: advanced TypeScript, the App Router, testing, deployment, and full-stack AI features.
- FastAPI β the backend and AI track: FastAPI services, Google Gemini, prompt engineering, RAG, agents, LLMOps, and production deployment.
- AI Engineering β the deep track: how to build agents that terminate, ground, and prove themselves, from the first model call to spec-driven mastery.
General Guidance: Professional Development Guidelines πΊπΈ¶
- Maintain high standards through thorough code reviews and testing
- Prioritize quality over speed - careful planning prevents future issues
- Focus on one task at a time using GitHub Projects for organization
- Practice clear communication:
- Use wikis for documentation
- Engage in discussions for knowledge sharing
- Create detailed issues for tracking work
- Start with simple, effective solutions before adding complexity
- Respect project scope - create new issues for additional features
- Deploy updates incrementally and document changes clearly
- Keep your team informed through regular updates
- Report problems thoroughly with clear reproduction steps
- Take ownership of the codebase - everyone is responsible for quality
- Leverage automation through GitHub Actions to ensure consistency
- Use standardized templates to streamline processes
Slow Is Smooth, Smooth Is Fast ποΈ¶
"Slow is smooth, smooth is fast."
You learned this on the range and in the stack: rush a movement and someone gets hurt and the objective slips away. So you move deliberately β clear each corner, confirm each step β and the deliberate pace is the fast pace, because you never have to double back and fix what haste broke.
Code is the same range. The engineer who skips the plan, skips the tests, and force-pushes to main looks fast for an afternoon and spends the next week untangling it. The one who scopes the work, writes the test first, reviews before merging, and deploys in small increments looks slower at every step β and ships sooner, because nothing has to be redone. Smooth is fast.
That is the standard we carry from the uniform to the keyboard: Integrity in every commit, Service to the team and the veterans who depend on the platform, Excellence held from the first line of code to production. Deliberate, honest, repeatable work β that is how we operate.
This is a Living Document¶
These SOPs are maintained and improved by the Vets Who Code community. All contributions are welcome!
How to Contribute¶
- Submit Pull Requests
- Improve existing documentation
- Add new sections based on experience
- Update technical references
-
Fix errors or clarify instructions
-
Report Issues
- Identify areas needing clarification
- Suggest new topics to cover
- Report outdated information
-
Request additional examples
-
Share Knowledge
- Document lessons learned
- Add field notes from your experience
- Contribute code examples
- Suggest process improvements
Contribution Guidelines¶
- Follow the Format
- Maintain military terminology
- Include clear examples
- Provide practical context
-
Keep documentation actionable
-
Maintain Standards
- Ensure technical accuracy
- Follow markdown formatting
- Include relevant references
-
Test any code examples
-
Review Process
- All changes undergo peer review
- Technical accuracy verification
- Style guide compliance check
- Community feedback integration
Remember: This document evolves with our community. Your experience transitioning from military service to software engineering is valuable - share it to help others succeed.
Together, we maintain excellence in our code and our conduct. πΊπΈ