Skip to content

Commit 388478d

Browse files
authored
Merge pull request #53 from Microsoft/erisch/features/contrib-guidelines
Adding Contributing Guidelines + PR Template
2 parents 02b2436 + dff05bc commit 388478d

37 files changed

+67
-0
lines changed

.github/CODEOWNERS

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Lines starting with '#' are comments.
2+
# Each line is a file pattern followed by one or more owners,
3+
# the last matching pattern has the most precendence.
4+
5+
# Core team members from cobalt
6+
* @erikschlegel

.github/CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing
2+
3+
Some general guidance around the process and steps to follow when contributing to this repository.
4+
5+
Clone the repo, and create a new feature branch on your local machine. Please name your feature branches by [convention](https://docs.microsoft.com/en-us/azure/devops/repos/git/git-branching-guidance?view=vsts#name-your-feature-branches-by-convention)(i.e. `$USER/bugfix/description`, `$USER/features/feature-area/feature-name`).
6+
7+
Make sure the tests pass both locally and through the CI build pipeline.
8+
9+
Push your branch to `origin` and submit a new pull request.
10+
11+
You should expect code reviewers to comment on pull requests within one business day. We may suggest some changes or improvements or alternatives.
12+
13+
Following an approval, the pull request submitter is responsible for squashing their commit messages completing their pr and deleting the branch.
14+
15+
Some things that will increase the chance that your pull request is accepted:
16+
17+
* Review our code review [guidance](https://github.com/Microsoft/code-with-engineering-playbook/blob/master/Engineering/CodeReviews.md).
18+
* Follow our [engineering playbook](https://github.com/Microsoft/code-with-engineering-playbook#the-basics) and the [style guide][style] for this project.
19+
* Include [unit tests](https://github.com/Microsoft/code-with-engineering-playbook/blob/master/Engineering/UnitTesting.md) and [end-to-end integration tests](https://martinfowler.com/bliki/IntegrationTest.html).
20+
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
21+
* Pull request changes should meet the minimum code coverage threshold.

.github/PULL_REQUEST_TEMPLATE.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## All Submissions:
2+
-------------------------------------
3+
* [YES/NO] Have you followed the guidelines in our Contributing [document](./CONTRIBUTING.md)?
4+
* [YES/NO] Have you added an explanation of what your changes do and why you'd like us to include them?
5+
* [YES/NO] I have updated the documentation accordingly.
6+
* [YES/NO/NA] I have added tests to cover my changes.
7+
* [YES/NO/NA] All new and existing tests passed.
8+
* [YES/NO/NA] My code follows the code style of this project.
9+
* [YES/NO/NA] I ran lint checks locally prior to submission.
10+
* [YES/NO] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
11+
12+
## What is the current behavior?
13+
-------------------------------------
14+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
15+
16+
Issue Number: N/A
17+
18+
19+
## What is the new behavior?
20+
-------------------------------------
21+
<!-- Please describe the behavior or changes that are being added by this PR. -->
22+
23+
-
24+
-
25+
-
26+
27+
## Does this introduce a breaking change?
28+
-------------------------------------
29+
- [YES/NO]
30+
31+
<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->
32+
33+
## Any relevant logs, error output, etc?
34+
-------------------------------------
35+
(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)
36+
37+
38+
## Other information
39+
-------------------------------------
40+
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

design-reference/architecture/README.md

Whitespace-only changes.

devops/providers/README.md

Whitespace-only changes.

devops/providers/azure-devops/README.md

Whitespace-only changes.

devops/providers/azure-devops/templates/azure-pipelines.yml

Whitespace-only changes.

infra/README.md

Whitespace-only changes.

infra/modules/README.md

Whitespace-only changes.

infra/modules/providers/azure/README.md

Whitespace-only changes.

infra/modules/providers/azure/api-mgmt/README.md

Whitespace-only changes.

infra/modules/providers/azure/api-mgmt/main.tf

Whitespace-only changes.

infra/modules/providers/azure/api-mgmt/output.tf

Whitespace-only changes.

infra/modules/providers/azure/api-mgmt/variables.tf

Whitespace-only changes.

infra/modules/providers/azure/app-gateway/README.md

Whitespace-only changes.

infra/modules/providers/azure/app-gateway/main.tf

Whitespace-only changes.

infra/modules/providers/azure/app-gateway/output.tf

Whitespace-only changes.

infra/modules/providers/azure/app-gateway/variables.tf

Whitespace-only changes.

infra/modules/providers/azure/service-plan/README.md

Whitespace-only changes.

infra/modules/providers/azure/service-plan/main.tf

Whitespace-only changes.

infra/modules/providers/azure/service-plan/output.tf

Whitespace-only changes.

infra/modules/providers/azure/service-plan/variables.tf

Whitespace-only changes.

infra/modules/providers/azure/tm-endpoint-ip/README.md

Whitespace-only changes.

infra/modules/providers/azure/tm-endpoint-ip/main.tf

Whitespace-only changes.

infra/modules/providers/azure/tm-endpoint-ip/output.tf

Whitespace-only changes.

infra/modules/providers/azure/tm-endpoint-ip/variables.tf

Whitespace-only changes.

infra/modules/providers/azure/tm-profile/README.md

Whitespace-only changes.

infra/modules/providers/azure/tm-profile/main.tf

Whitespace-only changes.

infra/modules/providers/azure/tm-profile/output.tf

Whitespace-only changes.

infra/modules/providers/azure/tm-profile/variables.tf

Whitespace-only changes.

infra/modules/providers/azure/vnet/README.md

Whitespace-only changes.

infra/modules/providers/azure/vnet/main.tf

Whitespace-only changes.

infra/modules/providers/azure/vnet/output.tf

Whitespace-only changes.

infra/modules/providers/azure/vnet/variables.tf

Whitespace-only changes.

infra/modules/providers/common/README.md

Whitespace-only changes.

infra/templates/README.md

Whitespace-only changes.

tests/lint-rules/README.md

Whitespace-only changes.

0 commit comments

Comments
 (0)