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

Jump to bottom

Update Contribution Guide #2380

Merged
merged 1 commit into from
Apr 8, 2021
Merged

Update Contribution Guide #2380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 4 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@

- [Testing](#testing)

- [Before Sending a Pull Request](#before-sending-a-pull-request)

- [Code Style Guide](#code-style-guide)

- [Lint the Code](#lint-the-code)
Expand All @@ -41,10 +39,11 @@ Help is always welcome. There are areas where you can help:
- The [website](https://github.com/date-fns/date-fns.org).

If you see a gap, but don't have time, experience, or you just need help
with the library, don't hesitate to [shoot an issue](https://github.com/date-fns/date-fns/issues/new).
with the library, don't hesitate to [start a discussion](https://github.com/date-fns/date-fns/discussions/new) or
[shoot an issue](https://github.com/date-fns/date-fns/issues/new).

The date-fns functionality is comprehensive and covers most of the use cases,
however it doesn't have extended time zone support. Please leave a comment
however it doesn't have an extended time zone support. Please leave a comment
to the [Extended time zones support issue](https://github.com/date-fns/date-fns/issues/180)
if you are interested in the functionality or want to help with development.

Expand Down Expand Up @@ -114,14 +113,6 @@ Build date-fns to test in in your project:
env PACKAGE_OUTPUT_PATH="$(pwd)/../PATH-TO-YOUR-MODULE/node_modules/date-fns" ./scripts/build/package.sh
```

## Before Sending a Pull Request

Rebuild FP functions, typings and indices by using the following script. It could take around a minute:

```sh
./scripts/build/build.sh
```

## Code Style Guide

### Lint the Code
Expand All @@ -140,7 +131,7 @@ yarn lint

### JSDoc

[JSDoc](http://usejsdoc.org) is used for the code documentation. Along with
[JSDoc](http://usejsdoc.org) is used for the code documentation. Along with the
standard JSDoc tags, date-fns uses `@category` tag that allows
to group functions.

Expand Down