Skip to content

Commit

Permalink
Docs: add Git LFS dependency to contribution guide (#4827)
Browse files Browse the repository at this point in the history
* docs: update CONTRIBUTION.md with git fls dependency

* docs: update CONTRIBUTING.md with some style changes

* docs: added and removed duplicate contributor

* chore: update contributors field

* chore: update contributors field

* chore: update contributors field

* chore: update contributors field

Co-authored-by: khendrikse <khendrikse@users.noreply.github.com>
Co-authored-by: token-generator-app[bot] <token-generator-app[bot]@users.noreply.github.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
  • Loading branch information
4 people authored Jul 19, 2022
1 parent 5d91429 commit 8bdd73c
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

These guidelines will help you send a pull request.

If you're submitting an issue instead, please skip this document.
If youre submitting an issue instead, please skip this document.

If your pull request is related to a typo or the documentation being unclear, please click on the relevant page's `Edit`
If your pull request is related to a typo or the documentation being unclear, please select on the relevant pages `Edit`
button (pencil icon) and directly suggest a correction instead.

This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
Expand All @@ -16,7 +16,7 @@ promote a positive and inclusive environment.

## Development process

First, fork and clone the repository. If you're not sure how to do this, please watch
First, fork and clone the repository. If youre not sure how to do this, please watch
[these videos](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).

Run:
Expand All @@ -33,11 +33,13 @@ npm test

**NOTE:**

In order to run all tests, make sure to have [Git LFS](https://git-lfs.github.com/) installed on your system.

Running some integration tests requires an active Netlify account to create a live site.

You can either provide a [Netlify Auth Token](https://docs.netlify.com/cli/get-started/#obtain-a-token-in-the-netlify-ui) (through the `NETLIFY_AUTH_TOKEN` environment variable) or login via `./bin/run login` before running the tests.

The tests don't count towards Netlify build minutes since they build a site locally and deploy it using the API.
The tests dont count towards Netlify build minutes since they build a site locally and deploy it using the API.

> You can disable these tests by setting the `NETLIFY_TEST_DISABLE_LIVE` environment variable to `true`.
Expand Down Expand Up @@ -76,7 +78,7 @@ The CLI is written using the [commander.js](https://github.com/tj/commander.js/)

A good place to start is reading the base command README and looking at the commands folder.

> If you'd like to learn more on how `netlify dev` works, see [here](./docs/netlify-dev.md)
> If youd like to learn more on how `netlify dev` works, check [here](./docs/netlify-dev.md)
### Testing

Expand All @@ -100,8 +102,8 @@ We also test for a few other things:
We actively welcome your pull requests.

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
2. If youve added code that should be tested, add tests.
3. If youve changed APIs, update the documentation.
4. Run `npm test` to run linting, formatting and tests.
5. Make sure to sync the docs by running `npm run docs`.

Expand All @@ -111,7 +113,7 @@ Merge the release PR

### Creating a prerelease

1. Create a branch named `releases/<tag>/<version>` with the version and tag you'd like to release.
1. Create a branch named `releases/<tag>/<version>` with the version and tag youd like to release.
2. Push the branch to the repo.

For example, a branch named `releases/rc.0/4.0.0` will create the version `4.0.0-rc.0` and publish it under the `rc.0` tag.
Expand Down

1 comment on commit 8bdd73c

@github-actions
Copy link

Choose a reason for hiding this comment

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

📊 Benchmark results

Package size: 227 MB

Please sign in to comment.