Skip to content

Commit

Permalink
fix: update typos, grammer, and formatting for .md files and comments (
Browse files Browse the repository at this point in the history
…microsoft#1229)

* fix: updated typos, grammer and formatting for .md files and comments

* update to fix broken link

* Minor updates based on PR comments

* fix CONTRIBUTING.md merge issues
  • Loading branch information
Falkicon authored Dec 28, 2018
1 parent 8d88c1e commit 8480939
Show file tree
Hide file tree
Showing 15 changed files with 185 additions and 184 deletions.
4 changes: 2 additions & 2 deletions .circleci/run-build-locally.sh
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
#!/usr/bin/env bash

# Debugging locally
# For complete details visit https://circleci.com/docs/2.0/examples/#video-test-your-config-file-locally
# For complete details visit https://circleci.com/docs/2.0/examples/#video-test-your-config-file-locally.

# 1. $ export CIRCLE_CI_TOKEN=some-value-created-by-personal-ci-account
# 2. $ cd ./.circleci
# 3. $ circleci config validate -c config.yml
# 4. $ bash run-build-locally.sh
# 5. Visit https://circleci.com/gh/Microsoft to see the running build just executed by the above steps
# 5. Visit https://circleci.com/gh/Microsoft to see the running build just executed by the above steps.

curl --user ${CIRCLE_CI_TOKEN}: \
--request POST \
Expand Down
14 changes: 7 additions & 7 deletions .circleci/run-coverage-locally.sh
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
#!/usr/bin/env bash
# To debug code coverage run with bash and debug (-x) from the directory root
# To debug code coverage run with bash and debug (-x) from the directory root.
# $ bash -x .circleci/run-coverage-locally.sh

# Prebuilt Binaries
# Prebuilt binaries
# Choose a binary below that matches your build environment.
# Linux : https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64gi
# MacOS : https://codeclimate.com/downloads/test-reporter/test-reporter-latest-darwin-amd64

# Setup Code Climate test-reporter
# If the package is not found then download from internet and set appropriate permissions
# Setup the Code Climate test-reporter.
# If the package is not found then download the package from code climate and set the appropriate permissions.
if [ ! -f ./coverage/cc-test-reporter ]; then
mkdir -p coverage/
curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-darwin-amd64 > ./coverage/cc-test-reporter
chmod +x ./coverage/cc-test-reporter
fi

# Code Coverage
# Notify Code Climate that a build is about to start
# Add --debug to cc-test-reporter when necessary
# Code coverage
# Notify Code Climate that a build is about to start.
# Add --debug to cc-test-reporter when necessary.
./coverage/cc-test-reporter before-build

for f in packages/*; do
Expand Down
20 changes: 10 additions & 10 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Code owners have the ability to approve a pull request that has made changes in the below files or package(s).
# At least one Code Owner will be required for any package.
# Approval for at least one *code owner* is required all packages.

# Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners
# the last matching pattern has the most precendence.
# Each line is a file pattern followed by one or more *code owners*.
# The last matching pattern has the most precendence.

# These owners will be the default owners for everything in the repo.
# These *code owners* will be the default owners for everything in the repository.
* @chrisdholt @janechu @nicholasrice

# File type specific owners

# Markdown specific files
*.md @awentzel @nalogiudice @chrisdholt
*.md @awentzel @nalogiudice @chrisdholt @falkicon
/docs/ @awentzel @nalogiudice @chrisdholt @falkicon
/website/ @awentzel @nalogiudice @chrisdholt @falkicon

# Package specific owners

# fast-animation
/packages/fast-animation/ @nicholasrice @chrisdholt
/packages/fast-animation/ @nicholasrice @chrisdholt

# fast-application-utils
/packages/fast-application-utils/ @janechu @chrisdholt
Expand Down Expand Up @@ -82,6 +82,6 @@
# Circle Ci
.circleci/ @awentzel @janechu @nicholasrice @chrisdholt

# DevOps
# Build scripts
*.yml @awentzel @janechu @nicholasrice @chrisdholt
build/ @janechu @nicholasrice @chrisdholt
build/ @janechu @nicholasrice @chrisdholt @awentzel
9 changes: 6 additions & 3 deletions .github/ISSUE_TEMPLATE/report-a-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ assignees: ''
**Describe the bug; what happened?**

**What are the steps to reproduce the issue?**

Example:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
Expand All @@ -21,8 +23,9 @@ Example:
**If applicable, provide screenshots:**

**In what environment did you see the issue?**
- OS & Device: [e.g. MacOS, iOS, Windows, Linux] on [iPhone 7, PC]
- Browser [e.g. Edge, Chrome, Safari, FireFox]
- Version [e.g. 1.8.0]

* OS & Device: [e.g. MacOS, iOS, Windows, Linux] on [iPhone 7, PC]
* Browser [e.g. Edge, Chrome, Safari, FireFox]
* Version [e.g. 1.8.0]

**Is there any additional context?**
20 changes: 13 additions & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
<!--- Provide a summary of your changes in the title field above. -->

# Pull request

## Description

<!--- Describe your changes. -->

## Motivation & context

<!--- What problem does this change solve? -->
<!--- Provide a link if you are addressing an open issue. -->

## Issue type checklist

<!--- What type of change are you submitting? Check the boxes that apply: -->
- [ ] **Bug fix**: non-breaking change which fixes an issue, link to the issue above.
- [ ] **New feature**: non-breaking change that adds functionality.
- [ ] **Breaking change**: fix or feature that will cause current functionality to change.

- [ ] **Chore**: A change that does not impact distributed packages.
- [ ] **Bug fix**: A non-breaking change which fixes an issue, link to the issue above.
- [ ] **New feature**: A non-breaking change that adds functionality.
- [ ] **Breaking change**: A fix or feature that will cause current functionality to change.

## Process & policy checklist

<!--- Review the list and check the boxes that apply. -->

- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes.
- [ ] I have read the CONTRIBUTING documentation and followed the standards set for this project.


Click here for details on [formatting pull requests](https://microsoft.github.io/fast-dna/docs/contributing/working#formatting-messages).
- [ ] I have read the [CONTRIBUTING](https://github.com/Microsoft/fast-dna/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://microsoft.github.io/fast-dna/docs/en/contributing/standards) set for this project.
28 changes: 14 additions & 14 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
pulls:
# Number of days of inactivity before an Issue or Pull Request becomes stale
# Number of days of inactivity before an issue or pull request becomes stale.
daysUntilStale: 5

# Number of days of inactivity before a stale Issue or Pull Request is closed.
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
# Number of days of inactivity before a stale issue or pull request is closed.
# Set to false to disable. If disabled, issues still need to be closed manually but remain marked as stale.
daysUntilClose: 7

# Comment to post when marking as stale. Set to `false` to disable
# Comment to post when marking as stale. Set to `false` to disable.
markComment: >
This pull request has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Limit the number of actions per hour, from 1-30. Default is 30
# Limit the number of actions per hour, from 1-30. The default is 30.
limitPerRun: 5

# Label to use when marking as stale
# Label to use when marking a pull request as stale.
staleLabel: "reason : stale"

# Comment to post when removing the stale label.
# unmarkComment: >
# Your comment here.

# Comment to post when closing a stale Issue or Pull Request.
# Comment to post when closing a stale issue or pull request.
# closeComment: >
# Your comment here.

issues:
# Number of days of inactivity before an Issue or Pull Request becomes stale
# Number of days of inactivity before an issue or pull request becomes stale.
daysUntilStale: 90

# Number of days of inactivity before a stale Issue or Pull Request is closed.
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
# Number of days of inactivity before a stale issue or pull request is closed.
# Set to false to disable. If disabled, issues still need to be closed manually but remain marked as stale.
daysUntilClose: 10

# Comment to post when marking as stale. Set to `false` to disable
# Comment to post when marking as stale. Set to `false` to disable.
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
# Issues or pull requests with these labels will never be considered stale. Set to `[]` to disable.
exemptLabels:
- "issue : task"
- "discuss : feature request"
- "[Status] Maybe Later"

# Label to use when marking as stale
# Label to use when marking as stale.
staleLabel: "reason : stale"

# Limit the number of actions per hour, from 1-30. Default is 30
# Limit the number of actions per hour, from 1-30. The default is 30.
limitPerRun: 25
Loading

0 comments on commit 8480939

Please sign in to comment.