Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Code of Conduct and Contributing origin

Browse Source
This commit is contained in:
Z
2018-08-03 10:02:13 +02:00
parent 5de067765e
commit 1acbe419e3
2 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/CODE_OF_CONDUCT.md vendored Normal file
View File

@@ -0,0 +1,2 @@
# Code of conduct
Read the general [adidas code of conduct](https://github.com/adidas/adidas-contribution-guidelines/wiki/Contributing#code-of-conduct).

12
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,12 @@
# Contributing
First off, thanks for taking the time to contribute!
To contribute to a adidas API Guidelines simply fork the repository, commit and push the changes and open a pull request.
## Review
Note, however, that adidas API Guidelines are followed by architects and engineers at adidas and as such any **pull request needs to be reviewed and approved by adidas API team**.
Some changes like typos, clarifications and examples can be approved relatively quick, however substantial changes, changes to the rules or addition of new rules are subject of a thorough review and approval process lead by the API team.
## Rendering at GitBook
The API guidelines are primarily intended for reading at <https://adidas.gitbook.io/api-guidelines/> and as such it needed to review the documentation rendering there, not in this GitHub repository (optimize for GitBook not GitHub).