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
20 changes: 19 additions & 1 deletion FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,22 @@ We try to fix high priority bugs ASAP.

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.
From time to time we do plan to close issues that are very old and have no activity.

## *Q. Why do I get the `stale[bot]` messages? Why is my issue marked as stale?*

We have recently configured the [GitHub stale BOT](https://github.com/probot/stale) as a scaling mechanism for us because there have been many issues that simply don't repro anymore or have been fixed without the triaging group seeing them/making the connection between fix->issue. The bot encourages issue openers to follow-up if it's still an active issue, and if it’s not, let’s close them.

### What issues will be automatically resolved?

We plan to resolve all issues before `October 1, 2017` automatically. For issues after that date, we are aggressively triaging them and creating a plan to get them fixed ASAP.

### How does Stale-bot work?

The bot sniffs out 'stale' issues in the repository based on date and activity. If an issue has not had any activity (comments, labels, title change, assignment, etc.) in certain number of (configurable) days, the Stale-bot will add the label 'no-recent-activity', and comment on the issue that it will be closed in 14-days if no further activity occurs. If no activity happens on this issue in the next two weeks, Stale-bot will automatically close the issue. This is intended to provide a reasonable level of cleanup so that valid issues don't get lost in the ocean of no longer relevant issues.

### But my issue is relevant, it’s just a long discussion! What can I do?

Stale-bot is versatile and has exemption labels, projects, and milestones. As of right now any issues marked 'Priority 0', 'Priority 1', 'Needs: discussion', and 'Needs: revisit' will never be marked stale.

We ask everyone to not abuse these. This cleanup is for better organization of the Fabric React project with the goal to increase visibility and response time on bugs and feature requests and organizing the issues is key to this endeavor. If there is a more semantic label to express, why your issue needs to stick around for multiple months tag the issue as such and we will triage it appropriately.
24 changes: 4 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,11 @@ ReactDOM.render(
document.body.firstChild
);
```
**[⬆ back to top](#Contents)**
Copy link
Copy Markdown
Contributor

@jordandrako jordandrako Apr 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you remove all the links to the ToC? #Resolved

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They were not working on GitHub. Will figure later why but for now they were creating noise and no value.


In reply to: 180925584 [](ancestors = 180925584)

Copy link
Copy Markdown
Collaborator

@oengusmacinog-zz oengusmacinog-zz Apr 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was assuming @manishgarg1 decided against them. Looked like he added them the other day. #Resolved

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, they were just not working. So I am yanking them out. Will fix them later in a way that they are funcitonal :)


In reply to: 180927395 [](ancestors = 180927395)


## Browser support

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

If you need to render Fabric components on the server side in a node environment, there is a way to do this. The basic idea is that you need to tell the styles loader to pipe styles into a variable, which you can later use to inject into your page. Example:
Expand Down Expand Up @@ -92,8 +89,6 @@ 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 @@ -128,20 +123,14 @@ In Jest:
}
```

**[⬆ 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](./ghdocs/BestPractices/Advanced.md).

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

## Contribute to Office UI Fabric React

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 read the [Git branch setup instrucions](./ghdocs/Contributing/Setup.md)**
Expand All @@ -158,14 +147,10 @@ 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](./ghdocs/BestPractices/Testing.md).

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

## Advanced building tips

The repo contains many packages, each which may have dependencies on each other. You can use the rush tool to build projects in the correct order, if you have it globally installed.
Expand All @@ -182,16 +167,12 @@ 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

We use [GitHub Releases](https://github.com/blog/1547-release-your-software) to manage our releases, including the changelog between every release. View a complete list of additions, fixes, and changes on the [releases](https://github.com/OfficeDev/office-ui-fabric-react/releases) page.
Expand All @@ -200,4 +181,7 @@ 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)**
## Issue management and `Stale-bot`

If you are getting `stale[bot]` messages and/or want to understand how we manage issues, please search for 'issue Triage' and/or 'stale[bot]' in the [FAQ](./FAQ.md).

2 changes: 1 addition & 1 deletion ghdocs/Contributing/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Please use the following steps to contribute a new component or a bug fix to the Office UI Fabric project.

* Setup your branch using instructions in [GitbranchSetup](./GitBranchSetup.md).
* Setup your branch using instructions in [Git branch Setup](./Setup.md).

* Read [BugFix](./BugFixes.md) guide for preparing a bug fix and the [New Component](./NewComponent.md) guide for building a new component.

Expand Down
4 changes: 3 additions & 1 deletion ghdocs/Contributing/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Next, clone and build the code.

```
- git clone https://github.com/johndoe/office-ui-fabric-react.git
- cd packages/office-ui-fabric-react
- npm install
- cd packages/office-ui-fabric-react
- npm run build
- npm start
```
Expand Down Expand Up @@ -90,6 +90,7 @@ From time to time, your fork will get out of sync with the upstream remote. Use
git fetch upstream
git checkout master
git pull upstream master
git push
```

## Merging upstream master into your current branch
Expand All @@ -99,6 +100,7 @@ From time to time, your current branch will get out of sync with the upstream re
```
git fetch upstream
git pull upstream master
git push
```

All done!