Skip to content

Commit

Permalink
updating the contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
tnylea committed May 4, 2024
1 parent ae5f51d commit ff42116
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,36 @@

Contributions are **welcome** and will be fully **credited**.

## Local Version

To get a local version working of DevDojo Auth.

- Create a new Laravel application
- Create a new folder at the root called `packages`
- Inisde the packages folder will be `devdojo/auth` where auth will be the contents of this repo
- Update your composer.json to include `devdojo/auth` inside the `repositories` key, and include the package inside the `require` key.

**composer.json example**

```
{
...
"require": {
...
"devdojo/auth": "*"
}
...
"repositories": [
{
"type" : "path",
"url" : "./packages/devdojo/auth"
}
],
}
```

Finally, run `composer update` and the package will be included in your project and is ready for development.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette
Expand Down

0 comments on commit ff42116

Please sign in to comment.