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: add getting started section to CONTRIBUTING.md #1244

Merged
merged 3 commits into from
Dec 28, 2018
Merged
Changes from 1 commit
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
Next Next commit
chore: add a getting started to contributing markdown
  • Loading branch information
Falkicon committed Dec 28, 2018
commit 93e420d48463f1e1b32771bb6fda3bc99cbeae9d
46 changes: 45 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,48 @@
# Contribution policy
# Contributing to FAST-DNA

## Getting started

[//]: # (Test comment...)
Falkicon marked this conversation as resolved.
Show resolved Hide resolved

### Installing

Once the repo has been cloned, install Lerna:

```bash
npm install -g lerna
```

Install dependencies in the root directory:

```bash
npm install
```

Install dependencies for packages within the project:

```bash
lerna bootstrap
```

Learn more about [installing](https://microsoft.github.io/fast-dna/docs/en/contributing/install).

### Testing

Run all tests for all packages:

```bash
lerna run test
```

Learn more about [testing](https://microsoft.github.io/fast-dna/docs/en/contributing/working).
Falkicon marked this conversation as resolved.
Show resolved Hide resolved

### Submitting a pull request

Before submitting a pull request, [rebase](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) your branch from master. Do not use ``git merge`` or the *merge* button provided by Github.

Learn more about [submitting pull requests](https://microsoft.github.io/fast-dna/docs/en/contributing/working).

## Contribution policy
A “Contribution” is any work that is voluntarily submitted to a project. This work may be code, documentation, design, answering questions, or even triaging issues.

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
Expand Down