diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2286852673..6994e24570 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -22,7 +22,7 @@ Contributing to Issues - Review the [Issue Label Descriptions](../docs/dev-process/issue-label-descriptions.md) - Check if the issue you are going to file already exists in our [GitHub issues][open-issues] -- If you can't find your issue already, [open a new issue](https://github.com/PowerShell/PowerShell/issues/new), making sure to follow the directions in the issue template as best you can. +- If you can't find your issue already, [open a new issue](https://github.com/PowerShell/PowerShell/issues/new), making sure to follow the directions in the [issue template](./ISSUE_TEMPLATE.md) as best you can. - If the issue is marked as [`Help Wanted`][help-wanted-issue], the PowerShell [maintainers][maintainers] are looking for help with the issue. Contributing to Documentation @@ -31,9 +31,11 @@ Contributing to Documentation Please see the [Contributor Guide in `PowerShell/PowerShell-Docs`](https://github.com/PowerShell/PowerShell-Docs/blob/staging/CONTRIBUTING.md). -### Contributing to documentation related to Contributing or maintaining the PowerShell Project +### Contributing to documentation related to contributing or maintaining the PowerShell Project -These issues should be treated like any other issue in this repo. See [Contribuing to Code](#contributing-to-code). +- When appropriate in writting markdown docs, use [semantic linefeeds](http://rhodesmill.org/brandon/2012/one-sentence-per-line/). + In most cases, it means "once sentence per line". +- Otherwise, these issues should be treated like any other issue in this repo. See [Contribuing to Code](#contributing-to-code). Contributing to Code ---- diff --git a/README.md b/README.md index 15eb6ba486..b0ef5314fc 100644 --- a/README.md +++ b/README.md @@ -34,16 +34,6 @@ Get PowerShell If installing PowerShell from a package, please refer to the installation documents for [Linux][inst-linux] and [Windows][inst-win]. -[releases]: https://github.com/PowerShell/PowerShell/releases -[artifacts]: https://ci.appveyor.com/project/PowerShell/powershell/build/artifacts -[build-wc]: docs/building/windows-core.md -[build-wf]: docs/building/windows-full.md -[build-osx]: docs/building/osx.md -[build-linux]: docs/building/linux.md -[pls-omi-provider]: https://github.com/PowerShell/psl-omi-provider -[inst-linux]: docs/installation/linux.md -[inst-win]: docs/installation/windows.md - Building PowerShell ------------------- @@ -62,13 +52,6 @@ captured and if a workaround exists. If you encounter issues with PowerShell itself, first search for it in our [issues][github-issues]. If you do not see your issue captured, please file a [new issue][new-issue] using the appropriate issue tag. -[contribution]: .github/CONTRIBUTING.md -[known-issues]: docs/KNOWNISSUES.md -[faq]: docs/FAQ.md -[github-issues]:https://github.com/PowerShell/PowerShell/issues -[new-issue]:https://github.com/PowerShell/PowerShell/issues/new - - PowerShell Community -------------------- `TODO` Missing community details @@ -87,6 +70,20 @@ This project has adopted the [Microsoft Open Source Code of Conduct][conduct-cod For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments. +[artifacts]: https://ci.appveyor.com/project/PowerShell/powershell/build/artifacts +[build-linux]: docs/building/linux.md +[build-osx]: docs/building/osx.md +[build-wc]: docs/building/windows-core.md +[build-wf]: docs/building/windows-full.md [conduct-code]: http://opensource.microsoft.com/codeofconduct/ -[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/ [conduct-email]: mailto:opencode@microsoft.com +[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/ +[contribution]: .github/CONTRIBUTING.md +[faq]: docs/FAQ.md +[github-issues]:https://github.com/PowerShell/PowerShell/issues +[inst-linux]: docs/installation/linux.md +[inst-win]: docs/installation/windows.md +[known-issues]: docs/KNOWNISSUES.md +[new-issue]:https://github.com/PowerShell/PowerShell/issues/new +[pls-omi-provider]: https://github.com/PowerShell/psl-omi-provider +[releases]: https://github.com/PowerShell/PowerShell/releases diff --git a/docs/dev-process/branch-structure.md b/docs/dev-process/branch-structure.md index 50ed89a513..759ba3eb65 100644 --- a/docs/dev-process/branch-structure.md +++ b/docs/dev-process/branch-structure.md @@ -1,3 +1,3 @@ author: Bruce ->Bruce: breaking changes contract (.NET Core has a great one) +> TBD: Branch structure of the project