FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add note about one sentance per line to CONTRIBUTING.md by vors · Pull Request #1315 · PowerShell/PowerShell · GitHub

Add note about one sentance per line to CONTRIBUTING.md - #1315

Merged
sergei (vors) merged 1 commit into
masterfrom
vors/linefeeds
Jul 14, 2016
Merged

sergei (vors) merged 1 commit into
masterfrom
vors/linefeeds

Conversation

Copy link
Copy Markdown
Collaborator
  • Resolves #xyz.
  • Code is up-to-date with master.
  • Add tests that fail without your changes.
  • Update all relevant documentation.

Copy link
Copy Markdown
Collaborator Author

Joey Aiello (@joeyaiello) @eslesar can you take a look?

Copy link
Copy Markdown

sergei (@vors) Joey Aiello (@joeyaiello) I think we should have a style guide, in the docs repo, that should be linked to in this section. I think having one line about style seems somewhat random here.

Copy link
Copy Markdown
Member

I think this is reasonable.

@eslesar isn't the docs repo for PowerShell consumers? I believe the consensus was to keep developer docs in one place, next to the code, in this repo, and style guides definitely fall under developer docs.

Copy link
Copy Markdown

I don't know of any such consensus that was reached regarding developer docs in this repo.

Either way, if there is going to be a style guide in this repo, that's fine, but this doc is pretty lean, and I don't think we should try to include style here. Just my opinion.

Copy link
Copy Markdown
Contributor

Andy Jordan (@andschwa) @eslesar Yes, that's true that the docs that are supposed to exist in this repository are specifically for people who are contributing in some way to the PowerShell/PowerShell project.

However, I think @eslesar's point is that, if the style guide for dev docs vs. user docs is the same, why not simply link between them?

Copy link
Copy Markdown
Collaborator Author

I agree with @eslesar, and we probably should borrow this line into PowerShell-Docs repo at some point. At the moment, almost all markdown in PowerShell-Docs violates this rule, so there is more work to put it there, then just copying.

I'm going to merge this PR, because I encounter cases, when I need to refer people to this sentence.

sergei (vors) merged commit 7db984a into master Jul 14, 2016
sergei (vors) deleted the vors/linefeeds branch July 15, 2016 00:40
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
Add note about one sentance per line to CONTRIBUTING.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants


Back | FazBrowse Home | New Git URL