This project is aimed to serve as a central repository for assets, solutions, and content aimed to serve US OCP AI partners.
Partners can leverage, fork, contribute and share content within this project as a traditional public repo.
This project welcomes contributions, assets and suggestions. The contributions within this project imply an agreement declaring that you grant the rights to use your contribution for public consumption.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
There are two ways in which you can help update the content:
-
Share Personal Public Repo:
If you are an ad-hoc contributor to the project, but you would like to maintain the changes within your personal repos and contribute the changes, the best way to do it is:- Fork from your personal repo into this project
- Periodically, update the "us-ocp-ai" repo to sync with your linked repo.
-
US-OCP-AI Original Repo:
If you plan to create content that originates from within this organization, thus you can update the content semi-regularly or regularly, each US OCP AI internal team member is listed as project's Owners group.
This GitHub project is a centralized library for Tier 1 assets, as defined by the US-OCP technical asset governance guidelines. To maintain quality contributions, the below is the required checklist for Tier 1 asset repos:
- Tags
- LICENSE
- README
- Description
- Repo naming conventions for consistency and searchability:
- Use lower cases
- Use dashes
- Avoid camel casing
- Be specific, descriptive, and brief
- e.g. predictive-maintenance
Below are the strongly encouraged but not required contribution guidelines that will facilitate team development of high quality software:
Leverage PR against master in order to merge your changes.
- Fork the repo or create a new feature branch
- Write in your contributions
- Create a PR into this repo
Branch Type | Pattern | Example |
---|---|---|
Feature | feature/<issue#>-<short description> | feature/498-reorganize-scm-section |
Bug Fix | fix/<bug#>-<short description> | fix/978-correct-grammar-myfile.md |
Note:
- Work should refer back to a feature/bug fix in the backlog.
- Mind the capitalization of the branch prefix (feature, fix). Tools that diplay branches as a hierarchy are typically case sensitive, and will display different hierarchies for the same words with different capitalization.
Consistent with the practices suggested in this playbook, please refer to the specifics regarding git as described in this section.
The following illustrates how the directory structure could be organized.
- README.md (Detailed Descriptions)
- /<Folder Structure>
- /<sub-folder 1>
- README.md
- /<sub-folder 2>
- README.md
Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE file.
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.
Privacy information can be found at https://privacy.microsoft.com/en-us/
Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.