Skip to content

Commit

Permalink
update github files
Browse files Browse the repository at this point in the history
  • Loading branch information
robinweser committed Feb 23, 2022
1 parent 02d4851 commit 6204a13
Show file tree
Hide file tree
Showing 4 changed files with 584 additions and 370 deletions.
26 changes: 10 additions & 16 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ If you have a feature request please create an issue. Also if you're even improv

## Project setup

We assume that you got [node](https://nodejs.org) and [yarn](https://yarnpkg.com) in your environment. To get started with the repo:
We assume that you got [node](https://nodejs.org) and [pnpm](https://pnpm.io) in your environment. To get started with the repo:

```
git clone [email protected]:robinweser/fela.git
cd fela
yarn
pnpm i
```

**Fela is a collection of multiple packages**. We use the tool [lerna](https://lernajs.io/) to maintain it. All source code can be found in the folder [/packages](packages).
**Fela is a collection of multiple packages**. We use the tool pnpm's workspace feature with [turbo](https://turborepo.org) to maintain it. All source code can be found in the folder [/packages](packages).

## Commands

Expand All @@ -24,38 +24,32 @@ In order to run the tests:
Tests:

```
yarn test
pnpm run test
```

Linting:

```
yarn lint
```

Flow:

```
yarn flow
pnpm run lint
```

Formatting:

```
yarn format
pnpm run format
```

You can also run all four of them at the same time:

```
yarn check
pnpm run check
```

Note: If your tests use other fela packages as depedencies, you might need to run `yarn build` (it's a part of `yarn setup`).
> **Note**: If your tests use other fela packages as depedencies, you might need to run `yarn build` (it's also part of the install step).
## Tip for developing

Fela contains many examples. It can be handy to smoke test your changes as a part of [example-react](http://fela.js.org/docs/introduction/Examples.html).
Fela contains many examples. It can be handy to smoke test your changes as a part of [example-react](https://fela.js.org/docs/latest/extra/examples#react).

## Code Formatting

Expand All @@ -66,7 +60,7 @@ We use [prettier](https://prettier.io/), an opinionated code formatter. If you'r
1. Fork the repo and create your feature/bug branch from `master`.
2. If you've added code that should be tested, add tests!
3. If you've changed APIs, update the documentation.
4. Ensure that all tests pass (`yarn check`).
4. Ensure that all tests pass (`pnpm run check`).

## Creating Issues

Expand Down
15 changes: 11 additions & 4 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,27 @@
------------------------------------------->

**Type**: Bug / Feature / Infrastructure / Docs / Question

<!------------------------------------------
Before choosing question, please consider asking on Sectrum as we might close question issues
------------------------------------------->


| Packages | Version |
| -------- | ------- |
| fela | 11.5.x |
| fela | 12.x.x |

---

-------------------
#### Description

Please try to add as much detail as possible.

<!---------------
BUG REPORT ONLY
---------------->

#### Steps to reproduce

<!--------------------
If possible, please provide a url to a repository that reproduces the issue or bug. If not possible, try to explain what you've done below
--------------------->
Expand All @@ -30,27 +33,31 @@ Please try to add as much detail as possible.
2. Second step

#### Expected Behavior

```javascript
// your code here
```

#### Actual Behavior

```javascript
// your code here
```

<!--------------------
FEATURE REQUEST ONLY
--------------------->

#### Proposal

Any information on how this might be achieved.

**Code Example**:

```javascript
// your proposal here
```


<!---------------------
REPORTING GUIDE-LINES
Expand Down
21 changes: 12 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,40 @@
------------------------------------------->

## Description

Add a description here.

## Example

If required, add a code example or a link to a working example (repository).

```javascript
// your code
// your code
```

## Packages

List all packages that have been changed.

-
-

## Versioning

None / Patch / Minor / Major

## Checklist

#### Quality Assurance
> You can also run `yarn run check` to run all 4 commands at once.

- [ ] The code was formatted using Prettier (`yarn run format`)
- [ ] The code has no linting errors (`yarn run lint`)
- [ ] All tests are passing (`yarn run test`)
- [ ] There are no flow-type errors (`yarn run flow`)
> You can also run `pnpm run check` to run all 4 commands at once.
- [ ] The code was formatted using Prettier (`pnpm run format`)
- [ ] The code has no linting errors (`pnpm run lint`)
- [ ] All tests are passing (`pnpm run test`)

#### Changes

If one of the following checks doesn't make sense due to the type of PR, just check them.

- [ ] Tests have been added/updated
- [ ] Documentation has been added/updated
- [ ] My changes have proper flow-types

Loading

0 comments on commit 6204a13

Please sign in to comment.