Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.62 KB
Raw

We realise that the initial content we created is just a starting point and our hope is that the community can help in the journey refining and extending the contents.

As a contributor, you represent that the content you submit is not plagiarised. By submitting the content, you (and, if applicable, your employer) are licensing the submitted content to LinkedIn and the open source community subject to the Creative Commons Attribution 4.0 International Public License.

Repository URL: https://github.com/linkedin/school-of-sre

Contributing Guidelines

Ensure that you adhere to the following guidelines:

  • 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).
  • Adhere to the Code of Conduct.
  • Should be relevant to the roles and responsibilities of an SRE.
  • Should be locally tested (see steps for testing) and well formatted.
  • 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.

Building and testing locally

Run the following commands to build and view the site locally before opening a PR.

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs build
mkdocs serve

Opening a PR

Follow the GitHub PR workflow for your contributions.

Fork this repo, create a feature branch, commit your changes and open a PR to this repo.