Skip to content

Commit 68c3e6d

Browse files
committed
Include contributions folder
De-dupe contribution guidelines
1 parent f514e70 commit 68c3e6d

File tree

9 files changed

+31
-79
lines changed

9 files changed

+31
-79
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ This project welcomes contributions, suggestions, and feedback. All contribution
66

77
Contributors must abide by the Mixed Reality Toolkit Organization's [code of conduct](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/CODE-OF-CONDUCT.md), [trademark policy](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/TRADEMARKS.md), and observe the following procedures:
88

9-
* [Project Tenets](./contributions/project-tenets.md)
10-
* [Code Contributions](./contributions/code-contributions.md)
11-
* [Opening and Assessing Issues](./contributions/opening-and-assessing-issues.md)
12-
* [Approving Pull Requests](./contributions/merging-pull-requests.md)
13-
* [Versioning and Releases](./contributions/versioning-and-releases.md)
9+
* [Project tenets](./contributions/project-tenets.md)
10+
* [Code contributions](./contributions/code-contributions.md)
11+
* [Opening and assessing issues](./contributions/opening-and-assessing-issues.md)
12+
* [Approving pull requests](./contributions/merging-pull-requests.md)
13+
* [Versioning and releases](./contributions/versioning-and-releases.md)
1414

1515
### GitHub roles
1616

Pipelines/Scripts/prepare-pages.ps1

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,31 @@ $destination = Join-Path $docs "CONTRIBUTING.md"
3838
New-Item -Path $destination -ItemType File -Force -Value @"
3939
---
4040
title: Contributing
41-
parent: Home
41+
nav_order: 6
4242
---
4343
4444
4545
"@
4646
Add-Content -Path $destination -Value (Get-Content -Path (Join-Path $ProjectRoot "CONTRIBUTING.md"))
4747

48+
$fileFolder = Join-Path $docs "contributions"
49+
New-Item -Path $fileFolder -ItemType Directory -Force
50+
51+
Get-ChildItem -Path (Join-Path $ProjectRoot "contributions") -File | ForEach-Object {
52+
# Create file, add front matter, and copy content
53+
$destination = Join-Path $fileFolder $_.Name
54+
$fileTitle = Select-String -Pattern "# (.+)" -Path $_ | Select-Object -First 1
55+
New-Item -Path $destination -ItemType File -Force -Value @"
56+
---
57+
title: $($fileTitle.Matches ? $fileTitle.Matches[0].Groups[1] : $_.BaseName)
58+
parent: Contributing
59+
---
60+
61+
62+
"@
63+
Add-Content -Path $destination -Value (Get-Content -Path $_)
64+
}
65+
4866
$destination = Join-Path $docs "LICENSE.md"
4967
# Create page, add front matter, and copy content
5068
New-Item -Path $destination -ItemType File -Force -Value @"

contributions/code-contributions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Code Contributions
1+
# Code contributions
22

33
This project is an open source project under the BSD 3-Clause license. Community contributions are welcome and appreciated, both for new features and bug fixes.
44

contributions/code-owners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Code Owners
1+
# Code owners
22

33
Code owners are Contributors that a maintain particular parts of the Project, and are defined in [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) file.
44

contributions/merging-pull-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Approving Pull Requests
1+
# Approving pull requests
22

33
All merges into the `main` branch must be done through a pull request process to ensure changes are reviewed and approved by code owners.
44

contributions/opening-and-assessing-issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Opening and Assessing Issues
1+
# Opening and assessing issues
22

33
All Contributors can open issues using the templates available for a [bug](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/issues/new?assignees=&labels=Bug&template=bug-report.md&title=), [document issue](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/issues/new?assignees=&labels=Documentation&template=documentation-issue.md&title=), [feature request](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/issues/new?assignees=&labels=Documentation&template=documentation-issue.md&title=), and [security vulnerability](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/security/advisories/new). Consider the following when opening a new Project issue:
44

@@ -11,7 +11,7 @@ All Contributors can open issues using the templates available for a [bug](https
1111

1212
## The role
1313

14-
Contributors with the **triage** role can assist with issue assessment.
14+
Contributors with the **triage** role can assist with issue assessment.
1515

1616
## Assessing issues
1717

contributions/project-tenets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MRTK3 Tenets
1+
# Project tenets
22

33
The following are the guiding principles by which the MRTK3 project abides. This is a living document and the list may be modified over time.
44

contributions/versioning-and-releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Versioning and Releases
1+
# Versioning and releases
22

33
## Semantic versioning
44

docs/mrtk3-overview/contributing.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)