Skip to content

Commit

Permalink
Create CONTRIBUTING.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
esgraham authored Jan 14, 2020
1 parent a61c6a7 commit 0fc74f0
Showing 1 changed file with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# 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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

# Section Structure/Pattern

Each section consist of the following partss

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
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](https://creativecommons.org/licenses/by/4.0/legalcode),
see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the
[LICENSE-CODE](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.

0 comments on commit 0fc74f0

Please sign in to comment.