From 6a84a62d71c3ae3e4f607422bee99701cb0d338a Mon Sep 17 00:00:00 2001 From: Ron Date: Wed, 12 Aug 2020 14:22:00 +0300 Subject: [PATCH 1/9] Adding new tutorial file --- docs/tutorials/my-first-issue.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/tutorials/my-first-issue.md diff --git a/docs/tutorials/my-first-issue.md b/docs/tutorials/my-first-issue.md new file mode 100644 index 000000000..26556b6e5 --- /dev/null +++ b/docs/tutorials/my-first-issue.md @@ -0,0 +1 @@ +### Thats Your Place To create Your First Issue \ No newline at end of file From dee1d98f8252a1626565d8940272f22a7bf8c10c Mon Sep 17 00:00:00 2001 From: Ron Date: Tue, 22 Sep 2020 13:09:30 +0300 Subject: [PATCH 2/9] addinng submit pull request section doc section --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e6d85ab4..70d21b14e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,59 @@ We would ❤️ for you to contribute to Appwrite and help make it better! We wa If you are worried or don’t know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can reach out with questions to [Eldad Fux (@eldadfux)](https://twitter.com/eldadfux) or [@appwrite_io](https://twitter.com/appwrite_io) on Twitter, and anyone from the [Appwrite team on Discord](https://discord.gg/GSeTUeA). You can also submit an issue, and a maintainer can guide you! + +## Submit a Pull Request 🚀 + +Branch naming convention is as following + +``` +TYPE-ISSUE_ID-DESCRIPTION + +example: +doc-548-submit-a-pull-request-section-to-contribution-guide +``` + +When `TYPE` can be: + +- **feat** - is a new feature +- **doc** - documentation only changes +- **cicd** - changes related to CI/CD system +- **fix** - a bug fix +- **refactor** - code change that neither fixes a bug nor adds a feature + +
+ +**All PRs must include commit message with the changes description!** + + +For the initial start, fork the project and use git clone command to download the repository to your computer +
+
+### A standard procedure for working on an issue would be to: + +### 1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date. +``` +$ git pull +``` +### 2. Create new branch from `master` like: `doc-548-submit-a-pull-request-section-to-contribution-guide`
+``` +$ git checkout -b [name_of_your_new_branch] +``` +### 3. Work - commit - repeat ( be sure to be in your branch ) +
+ +### 4. Push changes to GitHub using the command `git push`
+
+ +### 6. Submit your changes for review +If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. +### 7. Start a Pull Request +Now submit the pull request and , click on `Create pull request`. +### 6. Get a code review approval / reject +### 7. After approval, merge your PR +### 8. GitHub will automatically delete the branch, after the merge is done. (they can still be restored). +
+ ## Where to Start? Pull requests are great, but there are many other areas where you can help Appwrite. From 2150a2238e4ccd794fcff14b978b4729c341fc10 Mon Sep 17 00:00:00 2001 From: Ron Date: Tue, 22 Sep 2020 13:12:46 +0300 Subject: [PATCH 3/9] fixing submit pull request section --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70d21b14e..9be5ef39c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,7 +47,10 @@ $ git checkout -b [name_of_your_new_branch] ### 3. Work - commit - repeat ( be sure to be in your branch )
-### 4. Push changes to GitHub using the command `git push`
+### 4. Push changes to GitHub +``` +$ git push origin [name_of_your_new_branch] +```
### 6. Submit your changes for review From 7bde6bb4816bfee1fba00706213e503c1ad1b7bf Mon Sep 17 00:00:00 2001 From: "Eldad A. Fux" Date: Tue, 22 Sep 2020 15:46:28 +0300 Subject: [PATCH 4/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e2bb82a6..230d08981 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,6 +32,59 @@ After finishing the installation process, you can start writing and editing code Appwrite's current structure is a combination of both [Monolithic](https://en.wikipedia.org/wiki/Monolithic_application) and [Microservice](https://en.wikipedia.org/wiki/Microservices) architectures, but our final goal, as we grow, is to be using only microservices. +### File Structure + +```bash +. +├── app # Main application +│ ├── config # Config files +│ ├── controllers # API & dashboard controllers +│ │ ├── api +│ │ ├── shared +│ │ └── web +│ ├── db # DB schemas +│ ├── sdks # SDKs generated copies (used for generating code examples) +│ ├── tasks # Server CLI commands +│ ├── views # HTML server-side templates +│ └── workers # Background workers +├── bin # Server executables (tasks & workers) +├── docker # Docker related resources and configs +├── docs # Docs and tutorials +│ ├── examples +│ ├── references +│ ├── sdks +│ ├── services +│ ├── specs +│ └── tutorials +├── public # Public files +│ ├── dist +│ ├── fonts +│ ├── images +│ ├── scripts +│ └── styles +├── src # Supporting libraries +│ └── Appwrite +│ ├── Auth +│ ├── Database +│ ├── Docker +│ ├── Event +│ ├── Extend +│ ├── Network +│ ├── OpenSSL +│ ├── Preloader +│ ├── Resize +│ ├── Storage +│ ├── Swoole +│ ├── Task +│ ├── Template +│ ├── URL +│ └── Utopia +└── tests # End to end & unit tests + ├── e2e + ├── resources + └── unit +``` + --- ![Appwrite](docs/specs/overview.drawio.svg) --- From b973282c3376d0042ce7233b0f276f34079f989f Mon Sep 17 00:00:00 2001 From: "Eldad A. Fux" Date: Tue, 22 Sep 2020 15:47:43 +0300 Subject: [PATCH 5/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 230d08981..ee701b937 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,7 +62,7 @@ Appwrite's current structure is a combination of both [Monolithic](https://en.wi │ ├── images │ ├── scripts │ └── styles -├── src # Supporting libraries +├── src # Supporting libraries (each lib should have one specific role, common libraries are released as independent projects) │ └── Appwrite │ ├── Auth │ ├── Database From 157b7c5aa253a4476f0aa57f8dd1874993bd608d Mon Sep 17 00:00:00 2001 From: "Eldad A. Fux" Date: Tue, 22 Sep 2020 15:49:01 +0300 Subject: [PATCH 6/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee701b937..c91e165ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,7 +62,7 @@ Appwrite's current structure is a combination of both [Monolithic](https://en.wi │ ├── images │ ├── scripts │ └── styles -├── src # Supporting libraries (each lib should have one specific role, common libraries are released as independent projects) +├── src # Supporting libraries (each lib has one role, common libs are released as individual projects) │ └── Appwrite │ ├── Auth │ ├── Database From 0a50f66d08fa5adf637404717e36f1efb030283d Mon Sep 17 00:00:00 2001 From: "Eldad A. Fux" Date: Wed, 23 Sep 2020 06:58:36 +0300 Subject: [PATCH 7/9] Removed un-needed titles --- CONTRIBUTING.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39b16bf0c..7f89e4806 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,31 +39,28 @@ For the initial start, fork the project and use git clone command to do
### A standard procedure for working on an issue would be to: -### 1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date. +1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date. ``` $ git pull ``` -### 2. Create new branch from `master` like: `doc-548-submit-a-pull-request-section-to-contribution-guide`
+2. Create new branch from `master` like: `doc-548-submit-a-pull-request-section-to-contribution-guide`
``` $ git checkout -b [name_of_your_new_branch] ``` -### 3. Work - commit - repeat ( be sure to be in your branch ) -
+3. Work - commit - repeat ( be sure to be in your branch ) -### 4. Push changes to GitHub +4. Push changes to GitHub ``` $ git push origin [name_of_your_new_branch] ``` -
-### 6. Submit your changes for review +6. Submit your changes for review If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. -### 7. Start a Pull Request +7. Start a Pull Request Now submit the pull request and , click on `Create pull request`. -### 6. Get a code review approval / reject -### 7. After approval, merge your PR -### 8. GitHub will automatically delete the branch, after the merge is done. (they can still be restored). -
+6. Get a code review approval / reject +7. After approval, merge your PR +8. GitHub will automatically delete the branch, after the merge is done. (they can still be restored). ## Setup From Source From 86fa6551d3bed21324579b29529c661a66da2f9d Mon Sep 17 00:00:00 2001 From: "Eldad A. Fux" Date: Wed, 23 Sep 2020 06:59:42 +0300 Subject: [PATCH 8/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f89e4806..af914f9c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,15 +29,9 @@ When `TYPE` can be: - **fix** - a bug fix - **refactor** - code change that neither fixes a bug nor adds a feature -
- **All PRs must include commit message with the changes description!** - -For the initial start, fork the project and use git clone command to download the repository to your computer -
-
-### A standard procedure for working on an issue would be to: +For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to: 1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date. ``` From 0fd543074a928fa51c1f7dc742ac8908df46e86f Mon Sep 17 00:00:00 2001 From: "Eldad A. Fux" Date: Wed, 23 Sep 2020 07:01:40 +0300 Subject: [PATCH 9/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af914f9c6..0cb27cde2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,10 +14,10 @@ Help us keep Appwrite open and inclusive. Please read and follow our [Code of Co Branch naming convention is as following -``` -TYPE-ISSUE_ID-DESCRIPTION +`TYPE-ISSUE_ID-DESCRIPTION` example: +``` doc-548-submit-a-pull-request-section-to-contribution-guide ```