From 39b3bfcd4357d53bd50e6282acfcf03c55ffb6a3 Mon Sep 17 00:00:00 2001 From: Jianyun Tao Date: Fri, 24 Jun 2016 19:11:56 -0700 Subject: [PATCH] Created the docs layout --- docs/coding-guidelines/coding-guidelines.md | 9 +++++++++ docs/community/governance.md | 4 ++++ docs/community/legal-licensing.md | 1 + docs/dev-process/breaking-change-contract.md | 3 +++ docs/dev-process/code-review-guidelines.md | 2 ++ docs/dev-process/issue-management-process.md | 6 ++++++ docs/dev-process/pull-request-rules.md | 8 ++++++++ docs/dev-process/setup-dev-environment.md | 1 + docs/dev-process/tryit.md | 2 ++ docs/git/powershell-repository-101.md | 9 +++++++++ docs/{testing => testing-guidelines}/PesterDoAndDont.md | 0 docs/{testing => testing-guidelines}/Testing.md | 0 .../WritingPesterTests.md | 0 docs/testing-guidelines/testing-guidelines.md | 7 +++++++ 14 files changed, 52 insertions(+) create mode 100644 docs/coding-guidelines/coding-guidelines.md create mode 100644 docs/community/governance.md create mode 100644 docs/community/legal-licensing.md create mode 100644 docs/dev-process/breaking-change-contract.md create mode 100644 docs/dev-process/code-review-guidelines.md create mode 100644 docs/dev-process/issue-management-process.md create mode 100644 docs/dev-process/pull-request-rules.md create mode 100644 docs/dev-process/setup-dev-environment.md create mode 100644 docs/dev-process/tryit.md create mode 100644 docs/git/powershell-repository-101.md rename docs/{testing => testing-guidelines}/PesterDoAndDont.md (100%) rename docs/{testing => testing-guidelines}/Testing.md (100%) rename docs/{testing => testing-guidelines}/WritingPesterTests.md (100%) create mode 100644 docs/testing-guidelines/testing-guidelines.md diff --git a/docs/coding-guidelines/coding-guidelines.md b/docs/coding-guidelines/coding-guidelines.md new file mode 100644 index 0000000000..110d38457d --- /dev/null +++ b/docs/coding-guidelines/coding-guidelines.md @@ -0,0 +1,9 @@ +author: Jason + +> file encodings! +> performance standards +> platform support +> how to write portable code, tests, UI across platforms +> #ifdef +> note about internal APIs? +> avoid take dependency on code via reflection diff --git a/docs/community/governance.md b/docs/community/governance.md new file mode 100644 index 0000000000..54afe81e86 --- /dev/null +++ b/docs/community/governance.md @@ -0,0 +1,4 @@ +author: Joey +> PowerShell community, twitter, facebook, linkedIn...) +> Community ground rules, appeals process (if they disagree with our decision) +> SME diff --git a/docs/community/legal-licensing.md b/docs/community/legal-licensing.md new file mode 100644 index 0000000000..f6e3a5531f --- /dev/null +++ b/docs/community/legal-licensing.md @@ -0,0 +1 @@ +author: Joey diff --git a/docs/dev-process/breaking-change-contract.md b/docs/dev-process/breaking-change-contract.md new file mode 100644 index 0000000000..50ed89a513 --- /dev/null +++ b/docs/dev-process/breaking-change-contract.md @@ -0,0 +1,3 @@ +author: Bruce + +>Bruce: breaking changes contract (.NET Core has a great one) diff --git a/docs/dev-process/code-review-guidelines.md b/docs/dev-process/code-review-guidelines.md new file mode 100644 index 0000000000..a3e05e35c3 --- /dev/null +++ b/docs/dev-process/code-review-guidelines.md @@ -0,0 +1,2 @@ +author: Bruce +> Bruce: code reviews (style, ScriptAnalyzer rules to cover this) diff --git a/docs/dev-process/issue-management-process.md b/docs/dev-process/issue-management-process.md new file mode 100644 index 0000000000..11f6d365f9 --- /dev/null +++ b/docs/dev-process/issue-management-process.md @@ -0,0 +1,6 @@ +author: Andy + + +> meaning of label, assignees, etc. +> triage process +> requirements for resolving (timing), closing... diff --git a/docs/dev-process/pull-request-rules.md b/docs/dev-process/pull-request-rules.md new file mode 100644 index 0000000000..ed61156fe4 --- /dev/null +++ b/docs/dev-process/pull-request-rules.md @@ -0,0 +1,8 @@ +author: Hemant +> Hemant: "SLAs" for pull requests + > ALWAYS point to documents when critiquing PRs + > this should also include the blackbox of Windows/STEX testing + > time can totally be wishy-washy here + > "some tests we can only run internally" + > exact timeline not need for Aug17 + > Windows quality gates diff --git a/docs/dev-process/setup-dev-environment.md b/docs/dev-process/setup-dev-environment.md new file mode 100644 index 0000000000..95adbf7f10 --- /dev/null +++ b/docs/dev-process/setup-dev-environment.md @@ -0,0 +1 @@ +author: Sergei and Andy diff --git a/docs/dev-process/tryit.md b/docs/dev-process/tryit.md new file mode 100644 index 0000000000..1497276cbf --- /dev/null +++ b/docs/dev-process/tryit.md @@ -0,0 +1,2 @@ +author: Sergei and Andy +> steps for Trying out with the binaries a developer just built diff --git a/docs/git/powershell-repository-101.md b/docs/git/powershell-repository-101.md new file mode 100644 index 0000000000..f08592a294 --- /dev/null +++ b/docs/git/powershell-repository-101.md @@ -0,0 +1,9 @@ +author: Sergei and Andy + + + +>getting started working with PowerShell github +>branch structure intro + > branching (and folder) structure (where do I submit PRs? where's the release branch? dev branch? working branch?) +>PR process and requirements +> more diff --git a/docs/testing/PesterDoAndDont.md b/docs/testing-guidelines/PesterDoAndDont.md similarity index 100% rename from docs/testing/PesterDoAndDont.md rename to docs/testing-guidelines/PesterDoAndDont.md diff --git a/docs/testing/Testing.md b/docs/testing-guidelines/Testing.md similarity index 100% rename from docs/testing/Testing.md rename to docs/testing-guidelines/Testing.md diff --git a/docs/testing/WritingPesterTests.md b/docs/testing-guidelines/WritingPesterTests.md similarity index 100% rename from docs/testing/WritingPesterTests.md rename to docs/testing-guidelines/WritingPesterTests.md diff --git a/docs/testing-guidelines/testing-guidelines.md b/docs/testing-guidelines/testing-guidelines.md new file mode 100644 index 0000000000..85a9b17e65 --- /dev/null +++ b/docs/testing-guidelines/testing-guidelines.md @@ -0,0 +1,7 @@ +author: Jim + + +> Jason/Jim: Testing requirements (code coverage, required for incoming features/enhancements) + > local build/test execution instructions + > tools needed for build/test execution + > our CI explained