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.

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

chore: change all instances of fast-dna to fast #3381

Merged
merged 6 commits into from
Jun 26, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/report-a-bug.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Report a bug
about: Report a bug to help us improve FAST-DNA.
about: Report a bug to help us improve FAST.
title: "[what is the issue?] in [where is the issue?]"
labels: ''
assignees: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/request-a-feature.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Request a feature
about: Suggest a feature or share an idea for FAST-DNA.
about: Suggest a feature or share an idea for FAST.
title: Add [what] to/in [where]
labels: ''
assignees: ''
Expand Down
8 changes: 4 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@

- [ ] I have added a new component
- [ ] I have modified an existing component
- [ ] I have updated the [definition file](https://github.com/Microsoft/fast-dna/blob/master/packages/web-components/fast-components/CONTRIBUTING.md#definition)
- [ ] I have updated the [configuration file](https://github.com/Microsoft/fast-dna/blob/master/packages/web-components/fast-components/CONTRIBUTING.md#configuration)
- [ ] I have updated the [definition file](https://github.com/Microsoft/fast/blob/master/packages/web-components/fast-components/CONTRIBUTING.md#definition)
- [ ] I have updated the [configuration file](https://github.com/Microsoft/fast/blob/master/packages/web-components/fast-components/CONTRIBUTING.md#configuration)

## Process & policy checklist

Expand All @@ -38,7 +38,7 @@
- [ ] 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](https://github.com/Microsoft/fast-dna/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://www.fast.design/docs/en/contributing/standards) for this project.
- [ ] I have read the [CONTRIBUTING](https://github.com/Microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://www.fast.design/docs/en/contributing/standards) for this project.

<!---
Formatting guidelines:
Expand All @@ -65,6 +65,6 @@ Example titles:
- Do not end your description with a period.
- Avoid redundant words.
For additional information regarding working on FAST-DNA, check out our documentation site:
For additional information regarding working on FAST, check out our documentation site:
https://www.fast.design/docs/en/contributing/working
-->
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Contributing to FAST-DNA
# Contributing to FAST

## Getting started

### Machine setup

To work with the FAST-DNA [monorepo](https://en.wikipedia.org/wiki/Monorepo) you'll need Git, Node.js, Yarn, and Lerna setup on your machine.
To work with the FAST [monorepo](https://en.wikipedia.org/wiki/Monorepo) you'll need Git, Node.js, Yarn, and Lerna setup on your machine.

FAST-DNA uses Git as its source control system. If you haven't already installed it, you can download it [here](https://git-scm.com/downloads) or if you prefer a GUI-based approach, try [GitHub Desktop](https://desktop.github.com/).
FAST uses Git as its source control system. If you haven't already installed it, you can download it [here](https://git-scm.com/downloads) or if you prefer a GUI-based approach, try [GitHub Desktop](https://desktop.github.com/).

Once Git is installed, you'll also need Node.js, which FAST-DNA uses as its JavaScript runtime, enabling its build and test scripts. Node.js instructions and downloads for your preferred OS can be found [here](https://nodejs.org/en/).
Once Git is installed, you'll also need Node.js, which FAST uses as its JavaScript runtime, enabling its build and test scripts. Node.js instructions and downloads for your preferred OS can be found [here](https://nodejs.org/en/).

Because the FAST-DNA repository is structured as a monorepo, we'll need a couple of tools to manage that. The first is Yarn, which can be installed by executing the following command at the terminal:
Because the FAST repository is structured as a monorepo, we'll need a couple of tools to manage that. The first is Yarn, which can be installed by executing the following command at the terminal:

```shell
npm install -g yarn
Expand All @@ -28,15 +28,15 @@ The above steps are a one-time setup for your machine and do not need to be repe

### Cloning the repository

Now that your machine is setup, you can clone the FAST-DNA repository. Open a terminal and run this command:
Now that your machine is setup, you can clone the FAST repository. Open a terminal and run this command:

```shell
git clone https://github.com/microsoft/fast-dna.git
git clone https://github.com/microsoft/fast.git
```

### Installing and building

From within the `fast-dna` folder where you've cloned the repo, install all package dependencies and build all workspaces (local dependencies) with this command:
From within the `fast` folder where you've cloned the repo, install all package dependencies and build all workspaces (local dependencies) with this command:

```bash
yarn
Expand Down Expand Up @@ -91,19 +91,19 @@ When you submit a pull request, a CLA-bot automatically determines if you need t

## Guiding principle

Owners, the steering committee, collaborators, code owners, and contributors work in concert with one another on behalf of the FAST-DNA community and prioritize the communities interests over their own.
Owners, the steering committee, collaborators, code owners, and contributors work in concert with one another on behalf of the FAST community and prioritize the communities interests over their own.

The development, release, and work management processes must reflect this principle. Accepting contributions to the project requires a review by collaborators.

## Governance

### Owners

*Owners* have admin access and are responsible for the management, maintenance, and operations of the FAST-DNA repository.
*Owners* have admin access and are responsible for the management, maintenance, and operations of the FAST repository.

### Steering committee

*Steering committee* members are key *collaborators* who have demonstrated design or technical expertise critical to the driving the FAST-DNA project and community forward.
*Steering committee* members are key *collaborators* who have demonstrated design or technical expertise critical to the driving the FAST project and community forward.

### Collaborators

Expand All @@ -119,7 +119,7 @@ As subject matter experts, *code owners* approve pull requests on the packages t

### Nominations & appointments

* To become a *contributor*, a community member must have a pull request approved and merged into the FAST-DNA project master branch.
* To become a *contributor*, a community member must have a pull request approved and merged into the FAST project master branch.
* To become a *collaborator*, a *contributor* will petition the *steering committee* who will approve or deny the request.
* To become a *code owner*, a *collaborator* will be (a) nominated by a *steering committee* member or (b) petition the *steering committee* who will approve or deny the request.
* To join the *steering committee*, a *collaborator* will be nominated by a *steering committee* member and the *steering committee* who will approve or deny the request.
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-f8bc45.svg)](https://github.com/prettier/prettier)

[![Maintainability](https://api.codeclimate.com/v1/badges/8a74621e634a6e9b9561/maintainability)](https://codeclimate.com/github/Microsoft/fast-dna/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/8a74621e634a6e9b9561/test_coverage)](https://codeclimate.com/github/Microsoft/fast-dna/test_coverage)
![workflows](https://github.com/microsoft/fast-dna/workflows/CI%20-%20FAST/badge.svg?branch=master&event=push)
[![Maintainability](https://api.codeclimate.com/v1/badges/8a74621e634a6e9b9561/maintainability)](https://codeclimate.com/github/Microsoft/fast/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/8a74621e634a6e9b9561/test_coverage)](https://codeclimate.com/github/Microsoft/fast/test_coverage)
![workflows](https://github.com/microsoft/fast/workflows/CI%20-%20FAST/badge.svg?branch=master&event=push)

[![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.gg/FcSNfg4)
[![Twitter](https://img.shields.io/twitter/follow/fast_dna.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=fast_dna)
Expand Down Expand Up @@ -75,7 +75,7 @@ If you're looking to get started using our components right away, take a look at

## Joining the Community

Looking to get answers to questions or engage with us in realtime? Our community is most active [on Discord](https://discord.gg/FcSNfg4). You can also ask for help on [Stack Overflow](https://stackoverflow.com/questions/tagged/fast-dna), submit requests and issues on [Github](https://github.com/Microsoft/fast-dna/issues/new/choose), or join us by contributing on [some good first issues via Github](https://github.com/Microsoft/fast-dna/labels/good%20first%20issue).
Looking to get answers to questions or engage with us in realtime? Our community is most active [on Discord](https://discord.gg/FcSNfg4). Submit requests and issues on [Github](https://github.com/Microsoft/fast/issues/new/choose), or join us by contributing on [some good first issues via Github](https://github.com/Microsoft/fast/labels/good%20first%20issue).

We look forward to building an amazing open source community with you!

Expand Down Expand Up @@ -109,9 +109,8 @@ Because FAST has abstracted base components from their style, you get a head sta
## Contact

* Join the community and chat with us in real-time on [Discord](https://discord.gg/FcSNfg4).
* Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/fast-dna).
* Submit requests and issues on [Github](https://github.com/Microsoft/fast-dna/issues/new/choose).
* Contribute by helping out on some of our recommended first issues on [Github](https://github.com/Microsoft/fast-dna/labels/good%20first%20issue).
* Submit requests and issues on [Github](https://github.com/Microsoft/fast/issues/new/choose).
* Contribute by helping out on some of our recommended first issues on [Github](https://github.com/Microsoft/fast/labels/good%20first%20issue).

## Status

Expand Down
10 changes: 5 additions & 5 deletions build/testing/sauce-labs/test-browsers.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ function test(branchName) {
console.log("Testing Git branch:", branchName);

// Execute Selenium/Appium Web Drivers on Sauce Labs for each browser configuration
var flows = browsers.map(function(browser) {
var flows = browsers.map(function (browser) {
// Setup capabilities
let capabilities = {
name: "FAST-DNA Documentation",
name: "FAST Documentation",
build: branchName,
tags: "msft-docs",
appiumVersion: browser.appiumVersion,
Expand All @@ -111,7 +111,7 @@ function test(branchName) {
.build();

// Start session and execute test cases
driver.getSession().then(async function() {
driver.getSession().then(async function () {
try {
await driver.get(domain);

Expand Down Expand Up @@ -180,7 +180,7 @@ function test(branchName) {
/**
* Run tests on the current branch and use the branch name as the unique identifier on Sauce Labs
*/
new Promise(function(resolve, reject) {
new Promise(function (resolve, reject) {
const git = spawn("git", ["rev-parse", "--abbrev-ref", "HEAD"]);

git.stdout.on("data", data => {
Expand All @@ -189,6 +189,6 @@ new Promise(function(resolve, reject) {
git.stderr.on("data", data => {
reject("Unable to get branch name", data);
});
}).then(function(branchName) {
}).then(function (branchName) {
test(branchName);
});
8 changes: 4 additions & 4 deletions docs/en/contributing/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ sidebar_label: Install

## Prerequisites

Before setting up FAST-DNA, install Git and <a href="https://yarnpkg.com/en/docs/install" target="_blank">Yarn</a>.
Before setting up FAST, install Git and <a href="https://yarnpkg.com/en/docs/install" target="_blank">Yarn</a>.

## Setup the source repository

Clone the repository, `cd` into the project, install <a href="https://github.com/lerna/lerna" target="_blank">Lerna</a> and install dependencies:

```shell
git clone https://github.com/Microsoft/fast-dna.git
cd fast-dna
git clone https://github.com/Microsoft/fast.git
cd fast
yarn global add lerna
```

Expand Down Expand Up @@ -44,7 +44,7 @@ lerna run test

## Understanding packages

All packages can be found in the repository [packages](https://github.com/Microsoft/fast-dna/tree/master/packages) folder. Each package includes a `README.md` at its root for documentation.
All packages can be found in the repository [packages](https://github.com/Microsoft/fast/tree/master/packages) folder. Each package includes a `README.md` at its root for documentation.

## Dependencies

Expand Down
2 changes: 1 addition & 1 deletion docs/en/contributing/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For TypeScript projects, export all relevant files from the `index.ts` or `index

When a testing application is needed, it should be created in an `app` directory at the root of the package.

![Example of tracked folder structure with fast-package at the top and __tests__, app and src inside.](https://res.cloudinary.com/fast-dna/image/upload/v1546297640/creating_packages_tracked_folders.webp "")
![Example of tracked folder structure with fast-package at the top and __tests__, app and src inside.](https://res.cloudinary.com/fast/image/upload/v1546297640/creating_packages_tracked_folders.webp "")
*Example structure for tracked folders.*

### Untracked folders
Expand Down
6 changes: 3 additions & 3 deletions docs/en/contributing/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ sidebar_label: Policies

# Policies

* [Licensing](https://github.com/Microsoft/fast-dna/blob/master/LICENSE)
* [Contributions](https://github.com/Microsoft/fast-dna/blob/master/CONTRIBUTING.md)
* [Code of Conduct](https://github.com/Microsoft/fast-dna/blob/master/CODE_OF_CONDUCT.md)
* [Licensing](https://github.com/Microsoft/fast/blob/master/LICENSE)
* [Contributions](https://github.com/Microsoft/fast/blob/master/CONTRIBUTING.md)
* [Code of Conduct](https://github.com/Microsoft/fast/blob/master/CODE_OF_CONDUCT.md)
2 changes: 1 addition & 1 deletion docs/en/contributing/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Status

# Status

This page can be used to display the health of FAST-DNA systems.
This page can be used to display the health of FAST systems.

* [Circle CI - Status](https://status.circleci.com/)
* [Code Climate - Status](https://status.codeclimate.com/)
Expand Down
8 changes: 4 additions & 4 deletions docs/en/contributing/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,21 @@ lt --port 8000

[Sauce Labs](https://saucelabs.com/beta/dashboard/builds) lets collaborators and contributors execute automated tests against Selenium WebDriver on pre-configured browser matrix's.

The cross-browser testing strategy focuses on the differences between browser rendering engines. There are three different [configuration files](https://github.com/Microsoft/fast-dna/tree/master/build/testing) based on feature maturity of ongoing work.
The cross-browser testing strategy focuses on the differences between browser rendering engines. There are three different [configuration files](https://github.com/Microsoft/fast/tree/master/build/testing) based on feature maturity of ongoing work.

[Alpha](https://github.com/Microsoft/fast-dna/blob/master/build/testing/config-browsers.alpha.js) - immature feature development:
[Alpha](https://github.com/Microsoft/fast/blob/master/build/testing/config-browsers.alpha.js) - immature feature development:

```bash
node build/testing/sauce-labs/test-browsers.js alpha
```

[Beta](https://github.com/Microsoft/fast-dna/blob/master/build/testing/config-browsers.beta.js) - stable feature development:
[Beta](https://github.com/Microsoft/fast/blob/master/build/testing/config-browsers.beta.js) - stable feature development:

```bash
node build/testing/sauce-labs/test-browsers.js beta
```

[Release](https://github.com/Microsoft/fast-dna/blob/master/build/testing/config-browsers.release.js) - mature feature development:
[Release](https://github.com/Microsoft/fast/blob/master/build/testing/config-browsers.release.js) - mature feature development:

```bash
node build/testing/sauce-labs/test-browsers.js release
Expand Down
8 changes: 4 additions & 4 deletions docs/en/contributing/working.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_label: Working

## Managing issues

Well crafted issues improve the speed that work can be triaged, understood, and completed. To help guide this process [issue templates](https://github.com/Microsoft/fast-dna/tree/master/.github/ISSUE_TEMPLATE) exist to allow users to choose an appropriate [bug report](https://github.com/Microsoft/fast-dna/blob/master/.github/ISSUE_TEMPLATE/report-a-bug.md) or [feature request](https://github.com/Microsoft/fast-dna/blob/master/.github/ISSUE_TEMPLATE/request-a-feature.md).
Well crafted issues improve the speed that work can be triaged, understood, and completed. To help guide this process [issue templates](https://github.com/Microsoft/fast/tree/master/.github/ISSUE_TEMPLATE) exist to allow users to choose an appropriate [bug report](https://github.com/Microsoft/fast/blob/master/.github/ISSUE_TEMPLATE/report-a-bug.md) or [feature request](https://github.com/Microsoft/fast/blob/master/.github/ISSUE_TEMPLATE/request-a-feature.md).

Here's an excellent resource for [do's and don'ts](https://hackernoon.com/45-github-issues-dos-and-donts-dfec9ab4b612) when working with bugs, issues, and requests.

Expand All @@ -20,9 +20,9 @@ When landing a pull request (PR), individuals must modify the original commit me

PR commit messages should include the issue number per the [github closing issue keywords](https://help.github.com/articles/closing-issues-using-keywords/) documentation.

One or more collaborators are automatically assigned to review each PR based on areas of [ownership](https://github.com/Microsoft/fast-dna/blob/master/.github/CODEOWNERS).
One or more collaborators are automatically assigned to review each PR based on areas of [ownership](https://github.com/Microsoft/fast/blob/master/.github/CODEOWNERS).

When a peer review is created, a [template](https://github.com/Microsoft/fast-dna/blob/master/.github/pull_request_template.md) is provided that includes the best practices and processes for a review message.
When a peer review is created, a [template](https://github.com/Microsoft/fast/blob/master/.github/pull_request_template.md) is provided that includes the best practices and processes for a review message.

### Interim commits

Expand Down Expand Up @@ -84,7 +84,7 @@ yarn watch

If you run into any errors and they seem unrelated to your work try the following procedure:

Delete root node_modules (`fast-dna/node_modules`) then:
Delete root node_modules (`fast/node_modules`) then:

```bash
lerna clean
Expand Down
2 changes: 1 addition & 1 deletion docs/en/getting-started/the-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ When the base component renders, it will apply classes to elements from the *cla
```

#### How are components styled?
Base components are styled using [JSS](https://cssinjs.org/?v=v10.0.0) - a tool for generating stylesheets from JavaScript objects. Each JSS stylesheet conforms the the class-name contract defined by the component. [@microsoft/fast-jss-manager-react](https://github.com/microsoft/fast-dna/tree/master/packages/fast-jss-manager-react) is used to compose a component stylesheet with a base component, and will manage CSS creation, update, and removal processes during the component lifecycle.
Base components are styled using [JSS](https://cssinjs.org/?v=v10.0.0) - a tool for generating stylesheets from JavaScript objects. Each JSS stylesheet conforms the the class-name contract defined by the component. [@microsoft/fast-jss-manager-react](https://github.com/microsoft/fast/tree/master/packages/fast-jss-manager-react) is used to compose a component stylesheet with a base component, and will manage CSS creation, update, and removal processes during the component lifecycle.

#### What is the design system?
The *design-system* is all of the design data - it captures design thinking into a configuration object that informs components how to render. This can include information about color, font-weights, UI density, motion, and more. In practice, this object is provided to JSS stylesheets so that the resulting CSS is a product of the *design-system*.
Loading