mirror of
https://github.com/linkedin/school-of-sre
synced 2026-01-20 15:38:03 +00:00
Deployed 4239ecf with MkDocs version: 1.2.3
This commit is contained in:
@@ -2174,15 +2174,15 @@
|
||||
<h3 id="contributing-guidelines">Contributing Guidelines</h3>
|
||||
<p>Ensure that you adhere to the following guidelines:</p>
|
||||
<ul>
|
||||
<li>Should be about principles and concepts that can be applied in any company or individual project. Do not focus on particular tools or tech stack(which usually change over time).</li>
|
||||
<li>Should be about principles and concepts that can be applied in any company or individual project. Do not focus on particular tools or tech stack (which usually change over time).</li>
|
||||
<li>Adhere to the <a href="/school-of-sre/CODE_OF_CONDUCT/">Code of Conduct</a>.</li>
|
||||
<li>Should be relevant to the roles and responsibilities of an SRE.</li>
|
||||
<li>Should be locally tested (see steps for testing) and well formatted.</li>
|
||||
<li>Should be locally tested (see steps for testing) and well-formatted.</li>
|
||||
<li>It is good practice to open an issue first and discuss your changes before submitting a pull request. This way, you can incorporate ideas from others before you even start.</li>
|
||||
</ul>
|
||||
<h3 id="building-and-testing-locally">Building and testing locally</h3>
|
||||
<p>Run the following commands to build and view the site locally before opening a PR.</p>
|
||||
<pre><code>python3 -m venv .venv
|
||||
<pre><code class="language-shell">python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
mkdocs build
|
||||
|
||||
Reference in New Issue
Block a user