|
45 | 45 | <ul class="current">
|
46 | 46 | <li class="toctree-l2"><a class="reference internal" href="#why-have-sops">Why Have SOPs</a>
|
47 | 47 | </li>
|
48 |
| - <li class="toctree-l2"><a class="reference internal" href="#collection-i-core-fundamentals">Collection I: Core Fundamentals</a> |
49 |
| - <ul> |
50 |
| - <li class="toctree-l3"><a class="reference internal" href="#core-training-modules">Core Training Modules</a> |
| 48 | + <li class="toctree-l2"><a class="reference internal" href="#core-values-our-guiding-principles">Core Values: Our Guiding Principles 🇺🇸</a> |
51 | 49 | </li>
|
52 |
| - </ul> |
| 50 | + <li class="toctree-l2"><a class="reference internal" href="#general-guidance-your-tech-boot-camp-field-manual">General Guidance: Your Tech Boot Camp Field Manual 🇺🇸</a> |
53 | 51 | </li>
|
54 | 52 | </ul>
|
55 | 53 | </li>
|
|
77 | 75 | <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
78 | 76 | <div class="section" itemprop="articleBody">
|
79 | 77 |
|
80 |
| - <h1 id="vets-who-code-engineering-standard-operating-procedures-sops">Vets Who Code Engineering Standard Operating Procedures (SOPs)</h1> |
| 78 | + <h1 id="vets-who-code-engineering-standard-operating-procedures-sops">Vets Who Code Engineering Standard Operating Procedures (SOPs) 🇺🇸</h1> |
81 | 79 | <p>A veteran transitioning into software engineering through Vets Who Code...</p>
|
82 | 80 | <ul>
|
83 | 81 | <li>Has responsibilities to their unit – mentor, coach, and lead.</li>
|
84 | 82 | <li>Knows their <strong>SOPs</strong>. Follows their SOPs. Improves their SOPs if they are inefficient. If they find better SOPs, they incorporate them. If somebody could use their SOPs, they share them.</li>
|
85 | 83 | <li>Leads by example. Models the behaviors we desire both interpersonally and technically.</li>
|
86 | 84 | <li>Strives to understand how their work fits into a broader context and ensures mission success.</li>
|
87 | 85 | </ul>
|
88 |
| -<p>These are our Standard Operating Procedures for Software Engineering Core Fundamentals. All contributions are welcome! Please feel free to submit a pull request to get involved.</p> |
| 86 | +<p>These are our Standard Operating Procedures for Software Engineering as a Vets Who Code Troop. All contributions are welcome! Please feel free to submit a pull request to get involved.</p> |
89 | 87 | <h2 id="why-have-sops">Why Have SOPs</h2>
|
90 | 88 | <ul>
|
91 | 89 | <li>To increase overall efficiency for the entire Vets Who Code community.</li>
|
92 | 90 | <li>To reduce the number of errors and avoid common pitfalls in the transition of becoming software engineers.</li>
|
93 | 91 | <li>To strive to be better engineers and learn from shared experiences so we can flatten each others growth curve.</li>
|
94 | 92 | <li>To establish a consistent, high-quality approach to software development tasks.</li>
|
95 | 93 | </ul>
|
96 |
| -<p>If you do nothing else, follow the Engineering Fundamentals Checklist! (Link to be added)</p> |
97 |
| -<h2 id="collection-i-core-fundamentals">Collection I: Core Fundamentals</h2> |
98 |
| -<p>This collection of units and modules covers essential topics for software development. It equips you with the necessary skills and knowledge to build a strong foundation in coding, applicable across various programming domains. We're starting with the most fundamental modules, with more to come as we build out our curriculum.</p> |
99 |
| -<h3 id="core-training-modules">Core Training Modules</h3> |
| 94 | +<h2 id="core-values-our-guiding-principles">Core Values: Our Guiding Principles 🇺🇸</h2> |
| 95 | +<p>In the military, we focus on Integrity, Service, and Excellence - in that order. These core values are just as crucial in our mission to become outstanding software engineers:</p> |
100 | 96 | <ol>
|
101 |
| -<li><a href="command-line-bash/intro.md">Command Center: Mastering Command Line and Bash</a></li> |
102 |
| -<li>Master your primary interface for commanding computer operations</li> |
103 |
| -<li>Learn to navigate file systems, manipulate data, and automate tasks efficiently</li> |
104 |
| -<li>Understand the power of text-based computer interaction</li> |
| 97 | +<li><strong>Integrity First</strong>: In code as in combat, honesty is our bedrock. </li> |
| 98 | +<li>Write clean, readable code that tells the truth about its function.</li> |
| 99 | +<li>Admit to mistakes and learn from them. Debug with determination and transparency.</li> |
105 | 100 | <li>
|
106 |
| -<p>Harness the full potential of Bash scripting for task automation and system management</p> |
| 101 | +<p>Give credit where it's due in your commits and collaborations.</p> |
107 | 102 | </li>
|
108 | 103 | <li>
|
109 |
| -<p><a href="git-github/intro.md">Mission Control: Git and GitHub</a></p> |
| 104 | +<p><strong>Service Before Self</strong>: Your code serves your team, your users, and the larger mission.</p> |
110 | 105 | </li>
|
111 |
| -<li>Understand version control concepts and their importance in modern software development</li> |
112 |
| -<li>Learn to track changes, collaborate with others, and manage your codebase effectively</li> |
113 |
| -<li>Master the art of branching, merging, and resolving conflicts</li> |
114 |
| -<li>Utilize GitHub for project management, collaboration, and showcasing your work</li> |
| 106 | +<li>Prioritize maintainable, scalable solutions over quick personal wins.</li> |
| 107 | +<li>Contribute to open-source projects and support your fellow coders.</li> |
| 108 | +<li> |
| 109 | +<p>Always consider the end-user experience in your development decisions.</p> |
| 110 | +</li> |
| 111 | +<li> |
| 112 | +<p><strong>Excellence In All We Do</strong>: Strive for continuous improvement in your coding skills.</p> |
| 113 | +</li> |
| 114 | +<li>Regularly refactor and optimize your code. Good enough is never enough.</li> |
| 115 | +<li>Stay updated with the latest technologies and best practices in our field.</li> |
| 116 | +<li>Share your knowledge. Teaching others reinforces your own excellence.</li> |
115 | 117 | </ol>
|
| 118 | +<p>Remember, troop: these values are your compass in the ever-changing terrain of technology. Let them guide every line of code you write and every pull request you review.</p> |
| 119 | +<h2 id="general-guidance-your-tech-boot-camp-field-manual">General Guidance: Your Tech Boot Camp Field Manual 🇺🇸</h2> |
| 120 | +<ul> |
| 121 | +<li> |
| 122 | +<p>Maintain high standards in your code, soldier! Use GitHub's code review system like a buddy check before a jump – it ensures your code is mission-ready.</p> |
| 123 | +</li> |
| 124 | +<li> |
| 125 | +<p>Quality over speed, trooper. A well-planned assault beats a hasty advance. Craft your code with precision.</p> |
| 126 | +</li> |
| 127 | +<li> |
| 128 | +<p>Focus on one objective at a time. Use GitHub Projects like a mission board to prioritize your targets.</p> |
| 129 | +</li> |
| 130 | +<li> |
| 131 | +<p>Communication is key in our distributed unit. Use GitHub's wiki as your field manual, discussions for intel sharing, and issues to log mission objectives.</p> |
| 132 | +</li> |
| 133 | +<li> |
| 134 | +<p>K.I.S.S. - Keep It Simple, Soldier! Deploy basic, working solutions first. Use branches like you'd use different formations – test new maneuvers before integrating them into the main force.</p> |
| 135 | +</li> |
| 136 | +<li> |
| 137 | +<p>Stick to the mission parameters. If new intel comes in, create a new GitHub issue instead of changing the current mission objectives.</p> |
| 138 | +</li> |
| 139 | +<li> |
| 140 | +<p>Advance in small, tactical moves. Use GitHub releases to deploy frequent, incremental updates. Remember, inch by inch, anything's a cinch!</p> |
| 141 | +</li> |
| 142 | +<li> |
| 143 | +<p>Keep your squad informed. Update GitHub issues and pull requests like you'd update your team on the field. Clear intel keeps the unit aligned.</p> |
| 144 | +</li> |
| 145 | +<li> |
| 146 | +<p>Report bugs like you'd call in artillery – use GitHub issues with clear coordinates (steps to reproduce) and terrain details (code snippets or screenshots).</p> |
| 147 | +</li> |
| 148 | +<li> |
| 149 | +<p>We're all in this together, soldiers. The entire codebase is our base camp – we all have a duty to maintain and improve it.</p> |
| 150 | +</li> |
| 151 | +<li> |
| 152 | +<p>Use GitHub Actions like your automated supply line – it ensures your code is always ready for deployment.</p> |
| 153 | +</li> |
| 154 | +<li> |
| 155 | +<p>Standardize your approach with GitHub's templates. They're like field-tested battle plans – use them to make everyone's mission easier.</p> |
| 156 | +</li> |
| 157 | +</ul> |
| 158 | +<p>Remember, troops: these tools are your high-tech gear. They turn our distributed unit into a lean, mean, coding machine. Master them, and you'll be debugging like a pro and deploying code like a seasoned cyber warrior in no time.</p> |
| 159 | +<p>Stay frosty, keep coding, and let's show them what Vets Who Code can do! HUA! 🇺🇸</p> |
116 | 160 |
|
117 | 161 | </div>
|
118 | 162 | </div><footer>
|
@@ -156,5 +200,5 @@ <h3 id="core-training-modules">Core Training Modules</h3>
|
156 | 200 |
|
157 | 201 | <!--
|
158 | 202 | MkDocs version : 1.6.1
|
159 |
| -Build Date UTC : 2024-10-11 23:36:50.898903+00:00 |
| 203 | +Build Date UTC : 2024-10-11 23:46:14.277255+00:00 |
160 | 204 | -->
|
0 commit comments