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

Merge pull request #6 from adidas-group/migration-preps

Browse Source 
Prepare for the team migration
This commit is contained in:
Z
2018-08-03 14:29:11 +02:00
committed by GitHub
parent 03181acab0 1acbe419e3
commit 657bc6fd49
3 changed files with 35 additions and 1 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).

22
README.md
View File

@@ -25,7 +25,7 @@ The general guidelines section discusses the core principles relevant to any kin
### How to read the Guidelines
These Guidelines are available for online reading at [GitBook](https://apidesigner.gitbooks.io/adidas-api-guidelines/content/) its source can be found on [GitHub](https://github.com/adidas-group/api-guidelines).
These Guidelines are available for online reading at [GitBook](https://adidas.gitbook.io/api-guidelines/) its source can be found on [GitHub](https://github.com/adidas/api-guidelines).
The CAPITALIZED words throughout these guidelines have a special meaning:
@@ -41,3 +41,23 @@ Refer to [RFC2119](https://www.ietf.org/rfc/rfc2119) for details.
_Please contact_ [_Zdenek.Nemec@externals.adidas-group.com_](mailto:Zdenek.Nemec@externals.adidas-group.com) _in the case of questions._
## Intended Use Cases
This project is intended to provide the guidelines for design & development of APIs at adidas.
adidas is not responsible for the usage of this software for different purposes that the ones described in the use cases.
## License and Software Information
© adidas AG
adidas AG publishes this software and accompanied documentation (if any) subject to the terms of the MIT license with the aim of helping the community with our tools and libraries which we think can be also useful for other people. You will find a copy of the MIT license in the root folder of this package. All rights not explicitly granted to you under the MIT license remain the sole and exclusive property of adidas AG.
NOTICE: The software has been designed solely for the purpose of providing API design and development guidelines. The software is NOT designed, tested or verified for productive use whatsoever, nor or for any use related to high risk environments, such as health care, highly or fully autonomous driving, power plants, or other critical infrastructures or services.
If you want to contact adidas regarding the software, you can mail us at _software.engineering@adidas.com_.
For further information open the [adidas terms and conditions](https://github.com/adidas/adidas-contribution-guidelines/wiki/Terms-and-conditions) page.
### License
[MIT](LICENSE)