Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Contributing.md #271

Merged
merged 7 commits into from
Sep 29, 2019
Merged

Update Contributing.md #271

merged 7 commits into from
Sep 29, 2019

Conversation

vexx32
Copy link
Owner

@vexx32 vexx32 commented Sep 29, 2019 •
edited

PR Summary

Update contributing documentation with compatibility and code style information.

Context

See #234.

Changes

  • Add compatibility notes for writing koans.
  • Add workspace extension recommendations for VS Code.
  • Reformat blanks descriptions and move to section focused on writing koans.
  • Add information about standards for whitespace and comment styles

Checklist

  • Pull Request has a meaningful title.
  • Summarised changes.
  • Pull Request is ready to merge & is not WIP.
  • Added tests / only testable interactively.
    • Make sure you add a new test if old tests do not effectively test the code changed.
  • Added documentation / opened issue to track adding documentation at a later date.

@vexx32
📝 Update contributing documentation
39b3219
@vexx32
📝 Add VS Code extension recommendations
7bfeb0a
@vexx32
📝 Add compatibility notes to contributing doc
ad31b7d
@vexx32
📝 Update contributing file
fe39d29 
- Move blank format descriptions to writing koans section
- Reformat blank descriptions as a table
- Add details about comment and whitespace styles
@vexx32 vexx32 added PR-Needs-Review 🔍 Let's take a closer look! Category-Docs 📝 Pertaining to CBH, readme, other documentation labels Sep 29, 2019
@vexx32 vexx32 merged commit 4f2e142 into master Sep 29, 2019
@vexx32 vexx32 deleted the docs/Contributing branch September 29, 2019 12:56
@vexx32 vexx32 removed the PR-Needs-Review 🔍 Let's take a closer look! label Oct 2, 2019
thomasrayner pushed a commit to thomasrayner/PSKoans that referenced this pull request Oct 23, 2019
@vexx32 @thomasrayner
📝 Update Contributing.md (vexx32#271)
2dad239 
* 📝 Update contributing documentation

* 📝 Add VS Code extension recommendations

* 📝 Add compatibility notes to contributing doc

* 📝 Update contributing file
- Move blank format descriptions to writing koans section
- Reformat blank descriptions as a table
- Add details about comment and whitespace styles

* 📝 Update blanks table
Remove some unnecessary portions

* 📝 Add note for comment language
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@steviecoaster steviecoaster Awaiting requested review from steviecoaster

Assignees
No one assigned
Labels
Category-Docs 📝 Pertaining to CBH, readme, other documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@vexx32