Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
111 changes: 0 additions & 111 deletions CONTRIBUTING.md

This file was deleted.

129 changes: 129 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# [Office UI Fabric React FAQ](http://dev.office.com/fabric)

## *Q. What is Office UI Fabric React?*

Fabric React is a responsive, mobile-first, open-source collection of robust components designed to make it quick and simple for you to create web experiences using the `Office Design Language`.

## *Q. Who uses Office UI Fabric React?*

React components from Office UI Fabric React are used by many teams accross O365 and Microsoft for building their experiences. Some examples are SharePoint, OneDrive, Outlook, VisualStudio team services, ...

These components are also used by third party developers building extensiblity components using the SharePoint Framework.

## *Q. How do I get started with Office UI Fabric React?*

Start with our [README](./README.md) document.

To create your first app using Office UI Fabric React read the [Sample App](./ghdocs/OnBoarding/SampleApp.md) document.

## *Q. Where is the official website located?*

https://developer.microsoft.com/fabric

http://dev.office.com/fabric

## *Q. I am seeing a bug. Where can I open an issue?*

Please open all issues at our [GitHub issues](https://github.com/OfficeDev/office-ui-fabric-react/issues) location.

Things to remember while opening an issue

* Please fill out as many details as you can.
* We **highly encourage** you to submit PRs for issues.



```
----------------------------------------------------------------------------------------------

### Bug Report

- __Package version(s)__: (fill this out)
- __Browser and OS versions__: (fill this out if relevant)

#### Priorities and help requested (not applicable if asking question):

Are you willing to submit a PR to fix? (Yes, No)

Requested priority: (Blocking, High, Normal, Low)

Products/sites affected: (if applicable)

#### Describe the issue:

<!-- fill this out -->

#### Actual behavior:

<!-- fill this out -->

#### Expected behavior:

<!-- fill this out -->

### If applicable, please provide a codepen repro:

<!-- See http://codepen.io/dzearing/pens/public/?grid_type=list for a variety of examples -->

----------------------------------------------------------------------------------------------
```


## *Q. Can I contribute to Office UI Fabric React?*

Office UI Fabric React is an open-source distributed project. Lots of developers from inside and outside Microsoft contribute to this project. We highly encourage contributions. There is a core team that works hard to stay on top of the issues and pull requests.

## *Q. Why should I contribute?*

Office UI Fabric React is an open-source distributed project. If you are building a new app inside O365 or Microsoft, this project will potentially save you lots of time, resources and headaches. We encourage all developers who use Fabric React to return a small amount to the community. If you notice bugs, we encourage you to not only open an issue on it but also help fix it. If you have a component that you believe others should use, feel motivated and encouraged to contribute that component back to the community. Sharing is caring. Many developers contribute outside their primary job responsibilities. Additionally, there is plenty to learn. We use a lot of cutting edge best practices used in the industry. Learning those can help you in your career.

## *Q. How do I communicate with a Fabric React core team member?*

We have a very active community both outside and inside Microsoft. Please use the Microsoft [Teams channel](https://teams.microsoft.com/l/channel/19%3a73a5dbc26c9a4d8d91264611995bbdbb%40thread.skype/Fabric%2520Design?groupId=ffe264f2-14d0-48b5-9384-64f808b81294&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47) for communication from within Microsoft. And a [GitHub issue](https://github.com/OfficeDev/office-ui-fabric-react/issues) from outside Microsoft. We triage these issues at least once a week.

## *Q. How do I contribute to Office UI Fabric React?*

Start by reading our [Contributing](./ghdocs/Contributing/Contributing.md) document. Please point out any missing or incorrect details.

## *Q. Can I become a part of the Fabric core team?*

Yes, you totally can. You will need to help out with reviewing pull requests and triaging and fixing issues. For now, only Microsoft employees can be a part of the core team. We are looking into changing that policy to allow non-Microsoft folks to be a part of the core team.

## *Q. My pull request has been hanging for a long time. What do I do?*

We are very proactive and work hard to keep the outstanding pull request count low. But if your pull request is non-trivial and stuck for a long time, please feel free to tag the pull request that it has been hanging for long and you need help.

## *Q. Where do I read about specific best practices?*

Please refer to the following documents.

[**Contributing fixes and new components**](./ghdocs/Contributing/Contributing.md)

[**Accessibility**](./ghdocs/BestPractices/Accessibility.md)

[**Component Design**](./ghdocs/BestPractices/ComponentDesign.md)

[**Styling**](./ghdocs/BestPractices/Styling.md)

[**Theming**](./ghdocs/BestPractices/Theming.md)

[**Testing**](./ghdocs/BestPractices/Testing.md)

[**Advanced**](./ghdocs/BestPractices/Advanced.md)

[**Browse Support**](./ghdocs/Testing/BrowserSupport.md)

## *Q. When and how does the issue Triage work?*

The Fabric React core team works hard to stay on top of the open issues. We triage issues at least once a week. Due to an increased volume in the number of issues, we have been triaging more often. Once the issue count is under control, we may go back to the once a week rythm.

### Following issues will qualify as high priority

We try to fix high priority bugs ASAP.

* Is this issue blocking the consumer?
* Is this a regression? If yes, how and when did it get in?* Is this a very serious bug?

Other bugs will qualify as Normal or lower priority and will get fixed as a part of the normal release cadence.

From time to time we do plan to close issues that are very old and have no activity.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,13 @@ ReactDOM.render(
document.body.firstChild
);
```
**[⬆ back to top](#Contents)**

## Browser support

Fabric React supports many commonly used browsers. See the [browser support doc](https://github.com/OfficeDev/office-ui-fabric-react/blob/master/ghdocs/BROWSERSUPPORT.md) for more information.
Fabric React supports many commonly used browsers. See the [browser support doc](./ghdocs/Testing/BrowserSupport.md) for more information.

**[⬆ back to top](#Contents)**

## Server-side rendering

Expand Down Expand Up @@ -89,6 +92,8 @@ console.log(

Note: we are evaluating a more robust theming and style loading approach, which will allow a much more flexible server rendering approach, so this syntax may be simplified in the future.

**[⬆ back to top](#Contents)**

### Browserless Testing

In unit or end-to-end tests that run in an SSR-like (non-browser) environment such as Node, you'll need to disable style loading.
Expand Down Expand Up @@ -116,24 +121,30 @@ responsiveLib.setResponsiveMode(responsiveLib.ResponsiveMode.large);
You'll also want to mock out requiring `.scss` files.
In Jest:

```javascript
```js
moduleNameMapper: {
// jest-style-mock.js should just contain module.exports = {};
'\\.(scss)$': path.resolve(__dirname, 'jest-style-mock.js'),
}
```

**[⬆ back to top](#Contents)**

## Advanced usage

For advanced usage including info about module vs. path-based imports, using an AMD bundler like Require, and deployment features, see our [advanced documentation](https://github.com/OfficeDev/office-ui-fabric-react/blob/master/ghdocs/ADVANCED.md).
For advanced usage including info about module vs. path-based imports, using an AMD bundler like Require, and deployment features, see our [advanced documentation](./ghdocs/BestPractices/Advanced.md).

**[⬆ back to top](#Contents)**

## Contribute to Fabric React
## Contribute to Office UI Fabric React

Please take a look at our [contribution guidelines](https://github.com/OfficeDev/office-ui-fabric-react/blob/master/ghdocs/CONTRIBUTING.md) for more info.
Please take a look at our [contribution guidelines](./ghdocs/Contributing/Contributing.md) for more info. Also read [Contribute Bug fixes](./ghdocs/Contributing/BugFixes.md) and [Contribute New component](./ghdocs/Contributing/NewComponent.md).

**[⬆ back to top](#Contents)**

## Building the repo

Before you get started, **make sure you have [node.js](https://nodejs.org/) and [git](https://git-scm.com/) installed.**
Before you get started, **make sure you have read the [Git branch setup instrucions](./ghdocs/Contributing/Setup.md)**

To view the documentation including examples, contracts, component status, and to add functionality or fix issues locally, you can:

Expand All @@ -147,9 +158,13 @@ To build and run tests for all packages in the repo, you can run `npm run build`

To build individual packages within the `packages/*/` folders, you can use `npm run build` in each individually. Note that because the packages are symlinked together, you must manage building dependencies in the right order, or use the `rush` tool to build to the specific package you want. (See advanced tips below.)

**[⬆ back to top](#Contents)**

## Testing

For testing see our [testing documentation](https://github.com/OfficeDev/office-ui-fabric-react/blob/master/ghdocs/TESTING.md).
For testing see our [testing documentation](./ghdocs/BestPractices/Testing.md).

**[⬆ back to top](#Contents)**

## Advanced building tips

Expand All @@ -167,12 +182,15 @@ To can also build up to a specific project using the `--to <package>` argument.
rush build --to office-ui-fabric-react
```

**[⬆ back to top](#Contents)**

## Licenses

All files on the Office UI Fabric React GitHub repository are subject to the MIT license. Please read the License file at the root of the project.

Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms of the [assets license agreement](http://aka.ms/fabric-assets-license).

**[⬆ back to top](#Contents)**

## Changelog

Expand All @@ -181,3 +199,5 @@ We use [GitHub Releases](https://github.com/blog/1547-release-your-software) to
- - -

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

**[⬆ back to top](#Contents)**
Loading