Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

74 lines (59 loc) · 3.37 KB

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

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.

#Adding a new section

##Structure/Pattern

Each section consist of the following parts

  1. Summary
    1. Explain why this will positively impact the project
    2. What are potential consequences of not using this in my project?
    3. Describe how the concept works
  2. Detailed Description
    1. Dive into specific areas of what is described in the above summary (i.e Grooming > Estimation > establish baseline estimates)
  3. Recipes
    1. Tool specific implementations of the concept
    2. Named patterns or games that implement the concept (usually applies to agile cermonies)
  4. Case Studies
    1. Examples that illustrate how a team implemented the concept
    2. What problem was the team try to solve with their implementation?
    3. What worked well?
    4. Opportunities for improvement
    5. External Reference Material

Example Directory Hierarchy

The following illustrates how the directory structure could be organized.

- /continuous-integration
    - README.md (Conceptual)
    - /e2e-testing-in-ci
        - README.md
    - /static-code-analysis
        - README.md
    - /recipes
        - /azure-devops
            - versioning-ci-builds-in-azure-devops.md
            - sonar-qube-integration.md
            - ci-pipeline-for-dotnet-core.md
            - ci-pipeline-for-python.md
        - /jenkins
    - /case-studies
        - contoso-ci-pipeline-for-terraform.md

Legal Notices

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.