mirrors/school-of-sre
mirrors
/
school-of-sre
mirror of https://github.com/linkedin/school-of-sre.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add guidelines and improve contributing page

This commit is contained in:
Sumesh Premraj 2020-12-09 11:02:06 +05:30
parent 2e4a8870b0
commit 7d01fbafe0
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
courses/CONTRIBUTING.md
View File

@ -2,10 +2,17 @@ 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.
* 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.
@ -14,3 +21,8 @@ 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.