feat: add contributing guide (#99)

* feat: add contributing guide * fix: contributing guide link Co-authored-by: Sabin Adams <[email protected]>
sabinadams · May 7, 2022 · bad97dc · bad97dc
1 parent 187eb7a
commit bad97dc
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# How do I Contribute 💪
+
+we're excited to have you on board!
+
+- Take a look at the existing [Issues](https://github.com/YassinEldeeb/create-prisma-generator/issues) or [create a new issue](https://github.com/YassinEldeeb/create-prisma-generator/issues/new)!
+- Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
+- Create a **[Pull Request](https://github.com/YassinEldeeb/create-prisma-generator/compare)**, which will be reviewed and given suggestions for improvements.
+
+# Prerequisites
+Node.js version installed, [latest LTS is recommended](https://nodejs.org/en/about/releases/)
+
+# How do I start developing?
+Setup and install the needed dependencies by following these steps:
+
+```sh
+git clone https://github.com/sabinadams/aurora
+cd aurora
+npm i
+npm run dev
+```
+
+You're workflow will be as the following:
+
+1. Add/Remove/Update/Delete prisma schemas in the `prisma` directory when you're developing a new feature or fixing a bug.
+2. Make code changes.
+3. See the results of your changes in `generated.prisma` file.
diff --git a/README.md b/README.md
@@ -118,15 +118,13 @@ model Author {
     age       Int
     books     Book[]
 }
-
 model Book {
     id Int @id
     authorId Int
     author Author @relation(fields: [authorId], references: [id])
 }
 ```
 > Notice in the `Book` alias here, I only have to define the fields required to make the relationship.
-
 ##### Book.prisma
 ```prisma
 model Book {
@@ -137,7 +135,6 @@ model Book {
     releaseDate DateTime
     genre       String
 }
-
 model Author {
     id Int @id
     books Book[]
@@ -171,6 +168,12 @@ Aurora merges the fields to create one model with all relations defined.
 
 ---
 
+## Contributing
+
+We'll be very thankful for all your contributions, whether it's for helping us find issues in our code, highlighting features that're missing, writing tests for uncovered cases, or contributing to the codebase.
+
+Read the [Contributing guide](https://github.com/sabinadams/aurora/blob/master/CONTRIBUTING.md) to get started.
+
 ## Missing Something?
 
-If you have any questions or notice anything missing from this project, please feel free to create an issue or reach out to me on [twitter](https://twitter.com/sabinthedev)
+If you have any questions or notice anything missing from this project, please feel free to create an issue or reach out to me on [twitter](https://twitter.com/sabinthedev)