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.

Sign up for GitHub

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

[Demo & docs] Minor corrections to CONTRIBUTING.md #1681

Merged
merged 4 commits into from
Mar 13, 2024
Merged

[Demo & docs] Minor corrections to CONTRIBUTING.md #1681

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dca165d
Fix Wizard link (#1660)
vnbaaij Mar 8, 2024
616f79f
updates contributing.md file
oneolddev Mar 12, 2024
2e6bb75
Merge branch 'dev' into patch-1
vnbaaij Mar 12, 2024
072c8e6
Merge branch 'dev' into patch-1
oneolddev Mar 12, 2024
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
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,33 @@

### Machine setup

To begin you'll need Git and .NET setup on your machine.
To begin you'll need Git, .NET, and NodeJS setup on your machine.

The `fluentui-blazor` repo 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/).
The `fluentui-blazor` repository 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 .NET. Instructions and downloads for your preferred OS can be found [here](https://dotnet.microsoft.com/download).
Once Git is installed, you'll also need .NET and NodeJS. Instructions and downloads for .NET on your preferred OS can be found [here](https://dotnet.microsoft.com/download). NodeJS can be found [here](https://nodejs.org).

:::important
The above steps are a one-time setup for your machine and do not need to be repeated after the initial configuration.
:::

### Cloning the repository

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

```shell
git clone https://github.com/microsoft/fluentui-blazor.git
```

Cloning via SSH:

```shell
git clone [email protected]:microsoft/fluent-blazor.git
git clone [email protected]:microsoft/fluentui-blazor.git
```

### Installing and building

From within the folder where you've cloned the repo, install all package dependencies and build the project with the following command.
From within the folder where you've cloned the repo, build the project with the following command.

```bash
dotnet build
Expand All @@ -43,7 +44,6 @@ If you'd like to contribute by fixing a bug, implementing a feature, or even cor

If you are merging a pull request, be sure to use the pull request title as the commit title. The title should follow the [conventional commit guidelines](https://www.conventionalcommits.org/). It is recommended that if you are merging in pull requests regularly that you add a browser extension that will auto-correct the title for you. A few that should do this are [Refined GitHub](https://github.com/sindresorhus/refined-github) and [Squashed Merge Message](https://github.com/zachwhaley/squashed-merge-message).


## Contribution policy

A “Contribution” is work voluntarily submitted to a project. This submitted work can include code, documentation, design, answering questions, or submitting and triaging issues.
Expand Down