Commit Graph

39 Commits

Author SHA1 Message Date
Sean Wheeler
5595072568
Change docs.microsoft.com to learn.microsoft.com (#19994) 2023-07-17 15:54:17 -07:00
Travis Plunk
6f2737238a
Fix broken links in markdown (#16598)
* Update coding-guidelines.md

* Update coding-guidelines.md
2021-12-10 14:35:40 -08:00
xtqqczze
1b952a0cd5
Add documentation comments section to coding guidelines (#14316) 2021-04-20 09:15:54 -04:00
Ilya
927d20aec2
Fix a broken link in Code Guidelines doc (#14314) 2020-12-03 22:42:35 -08:00
xtqqczze
1d7a93c2e0
Enable CA1825: Avoid zero-length array allocations (#13961) 2020-11-04 08:56:26 +05:00
Kirk Munro
c752694b48 Identify renaming a parameter set as non-breaking in the breaking change contract document (#10113)
* Identify renaming a parameter set as non-breaking
Related discussion: https://github.com/PowerShell/PowerShell/issues/10058.

* Add note about S.M.A.Internal
2019-07-15 17:50:49 +05:00
Reece Dunham
7cc4889476 Documentation Cleanup (#8851) 2019-03-05 12:45:46 -08:00
Ilya
ee3a8c14c8 Update Coding Guidlines (#8844) 2019-02-11 10:41:00 -08:00
Travis Plunk
7bf4641444
Fix broken urls (#8653)
Fix broken URL
  - Also, move other static analysis tests into that CI.
  - Also, make the link analysis a pester test (partly to make sure the step fails in case of an error)
2019-01-15 16:20:45 -08:00
Christoph Bergmeister
fa544c33db Update links that contain 'en-us' culture (#7013)
Update links that contain 'en-us' culture to remove 'en-us' culture (if possible) and in some cases update to newer re-directed link to docs.microsoft.com
2018-06-08 10:49:03 +05:00
Ilya
ec1106a329 Add links on best practice guidelines in coding guideline (#4983) 2017-10-05 12:45:10 -07:00
Dongbo Wang
ede580e7d1 Improve the guideline for perf consideration (#4824)
* Improve the guideline for perf consideration

* Address comment
2017-09-14 09:24:49 +04:00
Dongbo Wang
ca1d2acfba Update coding guidelines (#4754)
* Update coding guidelines to make it more concrete and useful in a review process.

* Add a section about security

* Address comments

* Update .spelling

* Address more comments

* Address comment about the security section

* Fix 'i.e.' and 'e.g.'

* Update .spelling

* One more tweak

* Add motivation for using 'nameof'
2017-09-08 20:24:26 +04:00
Dongbo Wang
7762d7bf49 clean up map.json related files and scripts (#4532)
* clean up map.json related files and scripts

* Update .spelling
2017-08-10 13:32:19 -07:00
Travis Plunk
1a97af7e04 Fix heading for breaking change contract doc (#4224) 2017-07-11 14:15:34 -07:00
Travis Plunk
68bcd4b528 Removed trailing whitespace (#3485) 2017-04-11 09:44:43 -07:00
Jason Werry
1d33e12762 Fixed typos and improved text (#3394) 2017-03-22 10:17:21 -07:00
Andy Li
44f7951313 automatic spellchecking .md files in TravisCI (#838) 2016-10-31 18:02:26 -07:00
Dongbo Wang
d26b1d7155 Update coding-guidelines to encourage adding code comments (#2489) 2016-10-18 10:12:20 -07:00
Zakaria Ridouh
e4f3f8fd69 OS X -> macOS (#1934)
Fix all documentation references of "OS X" to be "macOS", Apple's new brand.

Code is left unchanged because we're matching .NET Core.
2016-08-26 15:08:50 -04:00
Pascal Borreli
dcce344087 Fixed typos 2016-08-18 18:11:57 +01:00
Jason Shirk
110c627be8 Doc updates, remove PR template, update issue labels (#1776)
* Remove PR template, update guidelines for PR

* Update testing-guidelines.md

* Add clarification on when to use runtime/compiletime checks

* Update issue label descriptions
2016-08-12 18:19:12 -07:00
joeyaiello
42019e511e refactor maintainer and governance docs
Now that we've gotten enough of a sign-off
from everyone involved in the governance
process, the docs need to be reworked to use a
consistent terminology set, links, and directory
structure.
2016-08-09 16:42:51 -07:00
joeyaiello
040c9803f7 respond to PR feedback on governance 2016-08-09 16:42:51 -07:00
joeyaiello
c15eb54fa1 first pass of governance doc
still need to do a considerable rewrite of other
contributor docs in order to change terminology
to align with governance.md
2016-08-09 16:42:51 -07:00
Jianyun Tao
1e7a49600d fixed the broken links and other minor updates due to the recent learning-powershell path changes. 2016-08-01 11:21:55 -07:00
AngelCalvo
5c5bda8427 Update breaking-change-contract.md 2016-07-26 10:27:49 -07:00
AngelCalvo
05ff5d35de Update breaking-change-contract.md 2016-07-26 09:58:44 -07:00
Jason Shirk
ad07bbeeac Merge pull request #1481 from lzybkr/jasonsh/docs
Coding guideline docs and other minor doc updates
2016-07-25 22:26:50 -07:00
Jason Shirk
d4c8688c13 Update issue labels doc 2016-07-25 21:57:01 -07:00
Jason Shirk (POWERSHELL)
8fcd8065be Coding guidelines first cut 2016-07-25 21:57:00 -07:00
Sergei Vorobev
639e669b7e Move files from docs/workflow to docs/dev-process
Remove branch-structure.md
2016-07-24 22:00:37 -07:00
hiteshraigandhi
874057e6bc Delete code-review-guidelines.md
This is not required.
2016-07-22 15:36:37 -07:00
Bruce Payette
9359bcaeee Initial full draft document
This is the initial draft of the PowerShell breaking changes guidelines documents. NOTE: this document is heavily based on the ,NET Core breaking changes document.
2016-07-20 14:49:50 -07:00
Travis Plunk
fd9cf03261 Addressed @jianyun `s and @vor 's PR comments 2016-07-19 16:36:08 -07:00
Travis Plunk
4c74e05972 Drafted update to contribution guidelines 2016-07-19 16:36:08 -07:00
joeyaiello
0eac00ed0b first pass of contributor docs
Rework of contributor docs to reflect actual flow
for both internal and external developers using
the PowerShell/PowerShell repo for the first time.
Includes updates to issue/PR guidelines, repo 101,
and CONTRIBUTING.md.
2016-07-12 13:39:36 -07:00
Sergei Vorobev
328f7b9984 Remove stub docs that should be platform specific 2016-07-06 20:42:16 -07:00
Jianyun Tao
39b3bfcd43 Created the docs layout 2016-06-24 19:11:56 -07:00