Merge pull request #34 from amplication/release/0.11.4

Release/0.11.4
amplication · Mar 6, 2022 · 854a6fb · 854a6fb
2 parents a1d6e89 + 845a2c9
commit 854a6fb
Show file tree

Hide file tree

Showing 69 changed files with 22,036 additions and 1,115 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -433,6 +433,53 @@
         "ideas",
         "bug"
       ]
+    },
+    {
+      "login": "abrl91",
+      "name": "Amit Barletz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/39680385?v=4",
+      "profile": "https://www.linkedin.com/in/amitbarletz/",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "MoFoGo",
+      "name": "Moshe Forman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/96979533?v=4",
+      "profile": "http://www.amplication.com ",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "molaycule",
+      "name": "Mohammed Agboola®️",
+      "avatar_url": "https://avatars.githubusercontent.com/u/20028628?v=4",
+      "profile": "https://m-agboola.web.app",
+      "contributions": [
+        "code",
+        "bug"
+      ]
+    },
+    {
+      "login": "morhag90",
+      "name": "morhag90",
+      "avatar_url": "https://avatars.githubusercontent.com/u/97830649?v=4",
+      "profile": "https://github.com/morhag90",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kwinyyyc",
+      "name": "Kwinten Li",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8462684?v=4",
+      "profile": "https://github.com/kwinyyyc",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,11 +1,10 @@
 # Contributing
 
-We would ❤️ it if you contributed to the project and helped make it even better.
-We make sure contributing to Amplication is easy, enjoyable, and educational for anyone and everyone. All contributions are welcome, including features, issues, documentation, translation, guides, and more.
+We would ❤️ it if you contributed to the project and helped make Amplication even better. We will make sure that contributing to Amplication is easy, enjoyable, and educational for anyone and everyone. All contributions are welcome, including features, issues, documentation, translation, guides, and more.
 
 ## Got a question?
 
-You can ask questions, consult with more experienced Amplication users, and discuss Amplication-related topics in the our [Discord channel](https://discord.gg/Z2CG3rUFnu).
+You can ask questions, consult with more experienced Amplication users, and discuss Amplication-related topics in the our [Discord channel](https://amplication.com/discord).
 
 ## Found a bug?
 
@@ -15,12 +14,12 @@ If you find a bug in the source code, you can help us by [submitting an issue](h
 
 You can request a new feature by [submitting an issue](https://github.com/amplication/amplication/issues/new?assignees=&labels=type%3A%20feature%20request&template=feature_request.md&title=) to our GitHub Repository.
 
-If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
+If you'd like to implement a new feature, it's always good to be in touch with us before you invest time and effort, since not all features can be supported.
 
-- For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you craft the change so that it's successfully integrated in the project.
+- For a Major Feature, first open an issue and outline your proposal. This will let us coordinate efforts, prevent duplication of work, and help you craft the change so that it's successfully integrated into the project.
 - Small Features can be crafted and directly [submitted as a Pull Request](#submit-pr).
 
-## What do I need to know to help?
+## What do you need to know to help?
 
 If you want to help out with a code contribution, our project uses the following stack:
 
@@ -41,60 +40,90 @@ If you want to help out with a code contribution, our project uses the following
 
 If you don't feel ready to make a code contribution yet, no problem! You can also check out the [documentation issues](https://github.com/amplication/amplication/labels/type%3A%20docs).
 
-## <a name="submit-pr"></a> How do I make a contribution?
+# <a name="submit-pr"></a> How do I make a code contribution?
 
-Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!
+Are you new to open source contribution? Wondering how contributions work in our project? Here's a quick rundown.
 
 Find an issue that you're interested in addressing, or a feature that you'd like to add.
 You can use [this view](https://github.com/amplication/amplication/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) which helps new contributors find easy gateways into our project.
 
-Fork the repository associated with the issue to your local GitHub organization. This means that you'll have a copy of the repository under your-GitHub-username/repository-name.
-Clone the repository to your local machine:
+## Step 1: Make a fork
+
+Fork the Amplication repository to your GitHub organization. This means that you'll have a copy of the repository under _your-GitHub-username/repository-name_.
+
+## Step 2: Clone the repository to your local machine
 
 ```
-git clone https://github.com/amplication/amplication
+git clone https://github.com/{your-GitHub-username}/amplication.git
 
 ```
 
-Create a new branch for your fix:
+## Step 3: Prepare the development environment
+
+Set up and run the development environment on your local machine:
+
+**BEFORE** you run the following steps make sure:
+1. You have typescript installed locally on you machine ```npm install -g typescript```
+2. You are using node version: ^16.3.0 || ^14.0.0"
+3. You are using npm version: ^8.1.0 || ^7.3.0"
 
+```shell
+cd amplication
+npm install
+npm run setup:dev
 ```
+
+## Step 4: Create a branch
+
+Create a new branch for your fix.
+
+```jsx
 git checkout -b branch-name-here
 ```
 
-Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
+## Step 5: Make your changes
 
-Once done, stage the changes that are ready to be committed:
+Update the code with your bug fix or new feature.
 
-```
+## Step 6: Add the changes that are ready to be committed
+
+Stage the changes that are ready to be committed:
+
+```jsx
 git add .
 ```
 
+## Step 7: Commit the changes (Git)
+
 Commit the changes with a short message. (See below for more details on how we structure our commit messages)
 
-```
+```jsx
 git commit -m "<type>(<package>): <subject>"
 ```
 
+## Step 8: Push the changes to the remote repository
+
 Push the changes to the remote repository using:
 
-```
+```jsx
 git push origin branch-name-here
 ```
 
-In GitHub, submit a pull request to the upstream repository. Title the pull request with a short description of the changes made and the issue or bug number associated with your change.
+## Step 9: Create Pull Request
+
+In GitHub, do the following to submit a pull request to the upstream repository:
 
-In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer.
+1.  Give the pull request a title and a short description of the changes made. Include also the issue or bug number associated with your change. Explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer.
 
-It's okay if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
+Remember, it's okay if your pull request is not perfect (no pull request ever is). The reviewer will be able to help you fix any problems and improve it!
 
-Wait for the pull request to be reviewed by a maintainer.
+2.  Wait for the pull request to be reviewed by a maintainer.
 
-Make changes to the pull request if the reviewing maintainer recommends them.
+3.  Make changes to the pull request if the reviewing maintainer recommends them.
 
-Celebrate your success after your pull request is merged!
+Celebrate your success after your pull request is merged :-)
 
-### Git Commit Messages
+## Git Commit Messages
 
 We structure our commit messages like this:
 
@@ -108,24 +137,24 @@ Example
 fix(server): missing entity on init
 ```
 
-List of types:
+### Types:
 
-- feat: A new feature
-- fix: A bug fix
-- docs: Changes to the documentation
-- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-- refactor: A code change that neither fixes a bug nor adds a feature
-- perf: A code change that improves performance
-- test: Adding missing or correcting existing tests
-- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Changes to the documentation
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing or correcting existing tests
+- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
 
-List of packages:
+### Packages:
 
-- server
-- client
-- data-service-gen
+- **server**
+- **client**
+- **data-service-gen**
 
-### Code of conduct
+## Code of conduct
 
 Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.