GitHub/school-of-sre
1
0
Fork 0
mirror of https://github.com/linkedin/school-of-sre synced 2026-01-20 23:48:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Code of Conduct and guidelines to contributing page (#46)

Browse Source 
* Add guidelines and improve contributing page
* Add code of conduct
* Link to code of conduct from sidebar
This commit is contained in:
Sumesh Premraj
2020-12-14 20:31:50 +05:30
committed by GitHub
parent b9679acf0a
commit c168d168d4
3 changed files with 56 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
courses/CONTRIBUTING.md
View File

@@ -2,15 +2,29 @@ We realise that the initial content we created is just a starting point and our
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.
We suggest to open an issue first and seek advice for your changes before submitting a pull request.
*Repository URL*: [https://github.com/linkedin/school-of-sre](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](/school-of-sre/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 [https://guides.github.com/introduction/flow/](GitHub PR workflow) for your contributions.
Fork this repo, create a feature branch, commit your changes and open a PR to this repo.