From 6a84a62d71c3ae3e4f607422bee99701cb0d338a Mon Sep 17 00:00:00 2001 From: Ron Date: Wed, 12 Aug 2020 14:22:00 +0300 Subject: [PATCH 1/3] 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 0000000000..26556b6e57 --- /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/3] addinng submit pull request section doc section --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e6d85ab42..70d21b14ef 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/3] fixing submit pull request section --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70d21b14ef..9be5ef39c2 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