Граф коммитов

39 Коммитов

Автор SHA1 Сообщение Дата
Jane Chu 78910b1158
Replace lerna and yarn with npm workspaces (#7000)
# Pull Request

## 📖 Description

This change replaces `yarn` and `lerna` with `npm` workspaces. This should help a lot with dependency management as we were on yarn 1 which had a fairly heavily manipulated dependency tree.

The changes also upgrade most dependencies to their latest versions and the changes may reflect this, such as updating all versions of webpack to webpack 5.

##  Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [x] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/master/CODE_OF_CONDUCT.md#our-standards) for this project.
2024-07-02 11:57:15 -07:00
Jane Chu 32446b8516
Remove @microsoft/fast-foundation and @microsoft/fast-web-utilities (#6996)
# Pull Request

## 📖 Description

This change removes:
- `@microsoft/fast-foundation` - the most recent version can be found on branch `archives/fast-foundation-3`
- `@microsoft/fast-web-utilities`

### 🎫 Issues

Closes #6951 and closes #6954

##  Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [ ] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/master/CODE_OF_CONDUCT.md#our-standards) for this project.

## ⏭ Next Steps

- File an issue to remove dependency on `@microsoft/fast-foundation` in `@microsoft/fast-ssr` for testing.
2024-06-26 10:47:50 -07:00
Jane Chu 5eb926a3f3
Update to the docs content to be `@microsoft/fast-element` specific (#6972)
# Pull Request

## 📖 Description

This update to the docs:
- Re-aligns docs around `@microsoft/fast-element`
- Adds more docs around the `html`, `css` and `FASTElement` exports  

## 👩‍💻 Reviewer Notes

There are 3 `TODO` marked documents that require separate PRs and reviews:
- DI (Dependency Injection)
- Migration (from `@microsoft/fast-element` v1 to v2) there may not be any breaking changes but there might be some suggestions for users looking to update their package
- Component library - with #6955 we are looking to assist the community in the creation of packages built on the `@microsoft/fast-element` package, this should provide some best practices and guidance on doing this.  

##  Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/master/CODE_OF_CONDUCT.md#our-standards) for this project.

## ⏭ Next Steps

- Fill in the `TODO` docs in separate PRs
2024-06-03 12:07:20 -07:00
Chris Holt 2297004e14
chore: lock lerna version for CI (#6805) 2023-08-11 16:17:17 -07:00
Aaron Wentzel d952fbd303
adds steering committee members by name (#6570)
Co-authored-by: Aaron Wentzel <awentzel@trans-stat.com>
2022-12-18 08:43:25 -07:00
Steph 283b4838d4
docs: versioning prep (#5990)
* update docusaurus version to 2.0.0-beta.20

* add keywords

* add md extensions to introduction file

* add md extensions to getting-started file

* add md extensions to fast-frame file

* add md extensions to getting started readme file

* add md extensions to defining-elements file

* add md extensions to declaring-templates file

* add md extensions to using-directives file

* add md extensions to next-steps file

* add md extensions to overview file

* add md extensions to creating-a-compound-library file

* add md extensions to design-tokens file

* add md extensions to aspnet file

* add md extensions to react file

* update join file

* add md extensions to contributing file

* add md extensions to writing-documentation file

* add md extensions to issue-management file

* add md extensions to release-planning file

* add md extensions to cheat-sheet file

* add md extensions to faq file

* update documentation footer

* update hideable sidebar configuration for Docusaurus 2.0.0-beta.20

* Change files

* minor grammar fixes

Co-authored-by: Rob Eisenberg <EisenbergEffect@users.noreply.github.com>
2022-05-26 13:31:19 -04:00
Chris Holt 890ff058b8
Remove fast components as a package and subsequently remove fast-component-explorer (#5853)
* remove fast-components package

* remove component explorer

* Change files

* remove references on the readme

* remove playwright from validate workflow which was only used in components

* fix test typings that were throwing

* Change files

* remove component explore workflow
2022-05-06 14:19:21 -07:00
Aaron Wentzel ed08697132
Update to fix broken links and grammar (#5868)
* update to fix bad links, grammar, and add dictionary items to vscode workspaces

* update to remove fixme tag because the item has already been closed and work completed

* Change files

* upgrade to latest beta

* update for consistent formatting

* update patch to type none

* update link

* update grammar based on review feedback

* update grammar

* update to remove duplicates

* remove controversial updates

* update to replace absolute path with relative paths to ensure works across both production and staging environments
2022-04-21 09:15:27 -07:00
Steph 617561d433
docs: fix unresolved links (#5873)
* add branch guide doc paths

* update branch guide doc route

* add branch guide to cheat sheet

* remove code introduced in a separate PR

Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>
2022-04-21 07:33:58 -07:00
Jane Chu 4aa6318233
Add documentation for assigning contributors to pull requests to ensure timely merging (#5714)
# Pull Request

## 📖 Description

<!---
Provide some background and a description of your work.
What problem does this change solve?
Is this a breaking change, chore, fix, feature, etc?
-->
This pull request adds documentation to the contribution policy which updates the process to include adding a specific assignee. The assignee will act as a final reviewer and it is their responsibility to merge contributions to the repository.

##  Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/Microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://www.fast.design/docs/community/code-of-conduct/#our-standards) for this project.
2022-04-19 11:11:26 -07:00
Jane Chu 02e58edb68
Added branch guidance (#5614)
# Pull Request

## 📖 Description

<!---
Provide some background and a description of your work.
What problem does this change solve?
Is this a breaking change, chore, fix, feature, etc?
-->
This change adds branch guidance for the creation of feature branches.

##  Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/Microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://www.fast.design/docs/community/code-of-conduct/#our-standards) for this project.
2022-02-22 11:38:12 -08:00
Dany Gagnon 6074cd24eb
docs: fix typo error in contributing.md (#5533)
* docs: fix typo error in contributing.md

* Update CONTRIBUTING.md

Co-authored-by: John Kreitlow <863023+radium-v@users.noreply.github.com>

Co-authored-by: John Kreitlow <863023+radium-v@users.noreply.github.com>
Co-authored-by: Chris Holt <chhol@microsoft.com>
Co-authored-by: Rob Eisenberg <EisenbergEffect@users.noreply.github.com>
2022-01-27 13:23:51 -05:00
Rob Eisenberg 9d4605ee0d
docs: fix incorrect link in contributing.md (#5456) 2021-12-10 10:21:04 -05:00
Rob Eisenberg bd7d84152a
docs: share our issue management, planning, and release policies (#5432)
* docs(engineering): add issue management docs

* docs: add release planning

* Update sites/website/src/docs/community/engineering-process/issue-management.md

Co-authored-by: Nicholas Rice <3213292+nicholasrice@users.noreply.github.com>

* Update sites/website/src/docs/community/engineering-process/issue-management.md

Co-authored-by: Jane Chu <7559015+janechu@users.noreply.github.com>

* docs: address header feedback

* chore: move acknowledgements to the correct place

* docs: add missing link

* docs: link process to tag info

* Change files

Co-authored-by: Nicholas Rice <3213292+nicholasrice@users.noreply.github.com>
Co-authored-by: Jane Chu <7559015+janechu@users.noreply.github.com>
Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>
Co-authored-by: EisenbergEffect <roeisenb@microsoft.com>
2021-12-07 16:39:37 -05:00
John Kreitlow c74e26b57f
add vscode settings and extension recommendations (#4574)
* add vscode settings and extension recommendations

* wrap markdown files at 90 columns

* add details for using VS Code workspace settings to contributing guide

Co-authored-by: Ibrahim Maga <imaga75@hotmail.com>
2021-08-06 15:01:03 -07:00
Jane Chu bde54bd852
fix the contributing docs api for yarn change which included an extra space before the branch option (#4746)
# Pull Request

## 📖 Description

<!---
Provide some background and a description of your work.
What problem does this change solve?
Is this a breaking change, chore, fix, feature, etc?
-->
This fixes an error in the `CONTRIBUTING.md` file where an extra space was added.

## 👩‍💻 Reviewer Notes

<!---
Provide some notes for reviewers to help them provide targeted feedback and testing.

Do you recommend a smoke test for this PR? What steps should be followed?
Are there particular areas of the code the reviewer should focus on?
-->
Attempting to use the suggesting yarn change api with the branch option did not work, removing the space fixes this therefore this update is to the contributing docs to remove the potential confusion for contributors.

## 📑 Test Plan

<!---
Please provide a summary of the tests affected by this work and any unique strategies employed in testing the features/fixes.
-->
Try using the contributing docs yarn change api, see it will not point to the suggested branch and will revert back to master.

##  Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [x] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/Microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://www.fast.design/docs/community/code-of-conduct/#our-standards) for this project.

### Component-specific

<!--- Review the list and put an x in the boxes that apply. -->
<!--- Remove this section if not applicable. -->

- [ ] I have added a new component
- [ ] I have modified an existing component
- [ ] 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)

## ⏭ Next Steps

<!---
If there is relevant follow-up work to this PR, please list any existing issues or provide brief descriptions of what you would like to do next.
-->

Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>
2021-05-21 12:34:04 -07:00
Chris Holt 40b64c7457
update contributing docs to include guidance for change files and feature branches (#4630)
Co-authored-by: Rob Eisenberg <EisenbergEffect@users.noreply.github.com>
2021-04-26 11:33:37 -04:00
Chris Holt 636f7cd54e
update contributing guide (#4542)
Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>
2021-04-09 09:55:52 -07:00
Dexter Lesaca c1b6d4a038
add development instructions to contributing.md (#3633)
Co-authored-by: Dexter Lesaca <v-dlesac@microsoft.com>
Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>
2020-08-10 08:52:00 -07:00
Jazib Jafri f3e61d467e
chore: update codeowners use absolute urll (#3577)
Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>
Co-authored-by: Nicholas Rice <nicholas.rice119@gmail.com>
2020-07-30 08:57:12 -07:00
Jazib Jafri 12446ce398
chore: fix typo in contributing.md (#3573)
Co-authored-by: Nicholas Rice <nicholas.rice119@gmail.com>
2020-07-29 09:42:39 -07:00
Jane Chu 4e18be8e0a
chore: add a linter for pull request titles (#3500)
<!--- Provide a summary of your changes in the title field above. For guidance on formatting, see the comment at the bottom of this template. -->

# Description

<!--- Describe your changes. -->
This change adds an action that will lint the pull request titles to ensure the follow conventional commits. It also adds in some contributor documentation for dealing with merging PRs.

## Motivation & context

<!--- What problem does this change solve? -->
<!--- Provide a link if you are addressing an open issue. -->
Too many commits are going in without the proper commit messages, this will result in erroneous change logs as well as incorrect versioning.

## Issue type checklist

<!--- What type of change are you submitting? Put an x in the box that applies: -->

- [x] **Chore**: A change that does not impact distributed packages.
- [ ] **Bug fix**: A change that fixes an issue, link to the issue above.
- [ ] **New feature**: A change that adds functionality.

**Is this a breaking change?**
- [ ] This change causes current functionality to break.

<!--- If yes, describe the impact. -->

**Adding or modifying component(s) in `@microsoft/fast-components` checklist**

<!-- Do your changes add or modify components in the @microsoft/fast-components package? Put an x in the box that applies: -->

- [ ] I have added a new component
- [ ] I have modified an existing component
- [ ] 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

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

- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] 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:

Accepted peer review title format:
<type>: <description>

Example titles:
    chore: add unit tests for all components
    feat: add a border radius to button
    fix: update design system to use 3px border radius

    <type> is required to be one of the following:

        - chore: A change that does not impact distributed packages.
        - fix: A change which fixes an issue.
        - feat: A that adds functionality.

    <description> is required for the CHANGELOG and speaks to what the user gets from this PR:

        - Be concise.
        - Use all lowercase characters. 
        - Use imperative, present tense (e.g. `add` not `adds`.)
        - Do not end your description with a period.
        - Avoid redundant words.

For additional information regarding working on FAST, check out our documentation site:
https://www.fast.design/docs/en/contributing/working
-->
2020-07-13 12:20:34 -07:00
gpresland 48fdb9822c
chore: correct GitHub spelling (#3486)
* Github > GitHub in docs and READMEs

* Github > GitHub on website

Co-authored-by: Greg Presland <gpresland+gitlab@gmail.com>
Co-authored-by: Nicholas Rice <nicholas.rice119@gmail.com>
Co-authored-by: Rob Eisenberg <EisenbergEffect@users.noreply.github.com>
2020-07-10 09:02:01 -04:00
Rob Eisenberg c1050679f8
chore: change all instances of fast-dna to fast (#3381)
* chore: change all instances of fast-dna to fast

* chore: revert cloudinary url changes

* chore: revert medium blog url change

* docs: fix some broken links in the intro
2020-06-25 20:17:56 -07:00
Rob Eisenberg 4c8c868f2f
docs: site build corrections, shared doc scrub, and new content (#3215)
* doc(website): improve build to merge root docs

* feat(website): filter specified components out of docs

* fix(website): remove unnecessary intermediary copy location

* doc(website): add writing documentation docs

* doc: improve contributing.md to include machine setup

* chore(website): update generated files

* chore(website): remove docs folder from git tracking

* chore(website): improve docs build to handle non-existent docs folders

* doc(website): add minimal browser support info

* doc(website): add some basic glossary definitions

* doc(fast-element): re-organize and fill out guides

* docs(website): add a few questions to the faq

* docs(website): add acknowledgements to the resource section
2020-06-02 15:44:29 -04:00
Aaron Wentzel 59bd4d3619
chore: update contributing documentation (#2930)
* update to improve speed of filing PR

* Revert "update to improve speed of filing PR"

This reverts commit 83c177ed77.

* update contributing documentation
2020-04-16 14:04:59 -07:00
Nicholas Rice e4cf2c7d70 Update CONTRIBUTING.md (#2392) 2019-10-29 11:34:49 -07:00
Chris Holt 4b7bb2d5dd
chore: update repository to yarn (#2382)
* test conversion to yarn

* test updated yaml for circleci

* fixing builds

* update circleci to install via yarn docs

* setup prettier as global install for test

* use sudo to install lerna

* update typings for tooling package plugin controls

* fix component explorer issues

* doc updates

* fix angular tests with tsconfig

* test cache and frozen lockfile

* ensure workspaces are built

* change build to prepare

* fixing tests

* update component explore readme conversion path for node modules

* setup tests to stream again

* update working documentation

* update lockfile

* change back to npm from yarn install

* update readmes to reflect npm vs yarn

* revert tooling changes
2019-10-29 11:14:51 -07:00
Aaron Wentzel c0587c1b82
update to switch to custom domain name for documentation (#1853) 2019-06-12 15:37:35 -07:00
Jane Chu f483160fa6
chore: add to contributor documentation on how to deal with breaking changes (#1754) 2019-05-23 10:00:22 -07:00
Jason Falk 8480939d3e
fix: update typos, grammer, and formatting for .md files and comments (#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
2018-12-27 20:16:56 -08:00
Jason Falk 8d88c1ec69
chore: add getting started section to CONTRIBUTING.md (#1244)
* chore: add a getting started to contributing markdown

* Formatting upates

* minor updates based on pr
2018-12-27 19:25:26 -08:00
Jane Chu 31dd8c74bd
docs: update CONTRIBUTING.md to include Code Owners (#623)
* update CONTRIBUTING.md to include Code Owners

* remove the list of expectations from Code Owners
2018-07-03 15:15:04 -07:00
Aaron Wentzel e92c1d8d77
docs: update to contribution policy (#490)
* docs: update to contribution policy

Updates Team/Group names for better management and alignment into open source

* update spelling error
2018-05-31 17:17:03 -07:00
Aaron Wentzel 24514e8b36
docs: remove non-contributor specific language (#153)
* docs: extracted non-contributor specific language

* docs: updated grammar
2018-03-29 13:10:39 -07:00
Nicholas Rice e74f953ad3 fix: ensure app build and tslint processes run prior in the build gate (#132)
* fix webpack errors and update script names

* update fast-animation script names

* removing eslint

* align process names

* add tslint processes to fast-animation

* fixing build of browser-extension

* add lint tasks to all projects

* remove tslint from root project

* formatting imports

* fixing root unit tests

* fixing errors

* adding documentation

* revert unwanted change and fix casing

* correcting instructions
2018-03-27 09:44:32 -07:00
Aaron Wentzel 2c679316a4 docs: updates developer documentation (#131)
* docs: updates developer documentation

* Updates content and fixes a couple grammar issues
2018-03-23 17:44:58 -07:00
Aaron Wentzel 33c327fc07 docs: update documentation for contributions, code of conduct, and pa… (#19)
* docs: update documentation for contributions, code of conduct, and packages

* updated conventional changelog details per feedback from team
2018-03-07 19:03:14 -08:00
Nicholas Rice e70acfd6d3 feat: adds fast-react-jss-manager project (#2)
* adding contribution policy and contribution guides

* clean package.json in prep for monorepo

* adding getting-started documentation

* adding lerna

* adding linting process

* adding author

* adding fast-react-jss-manager

* adding react-jss-manager

* adding commit message details to the readme

* renaming package

* removing duplication of content

* point package.json repository to the correct repository

* updating packages
2018-03-02 16:35:22 -08:00