From e459ecc122bf23977582ca94f3b3cb210bc22bf5 Mon Sep 17 00:00:00 2001 From: Louis Schmieder <dev@louis-schmieder.de> Date: Wed, 15 Jul 2020 18:18:07 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 34d70f0f..ab9a7ca3 100644 --- a/README.md +++ b/README.md @@ -42,3 +42,13 @@ Required dependencies: Gitly will support Postgres and MySQL in the future (once V ORM does).  + + +## Contributing +Example workflow: +[1] Fork the project +[2] Add your feature +[3] Push it to your fork +[4] Make a pull request + +We want the code as simple as possible. From fcb36ac562aa62eec9780d97ef6d668c0d69319d Mon Sep 17 00:00:00 2001 From: Louis Schmieder <dev@louis-schmieder.de> Date: Wed, 15 Jul 2020 23:05:59 +0200 Subject: [PATCH 2/3] add github flow link & improve workflow list --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ab9a7ca3..339ca0b0 100644 --- a/README.md +++ b/README.md @@ -45,10 +45,18 @@ Gitly will support Postgres and MySQL in the future (once V ORM does). ## Contributing -Example workflow: -[1] Fork the project -[2] Add your feature -[3] Push it to your fork -[4] Make a pull request +Workflow: +1. Fork the project +1. Add your feature +1. Create a branch `git branch YOUR-FEATURE-TITLE` +1. Checkout the branch `git checkout YOUR-FEATURE-TITLE` +1. Add your features to the head `git add .` +1. Commit your features `git commit -m "edit message"` +1. Add your fork as remote `git remote add fork LINK-TO-THE-FORK-REPO` +1. Push it to your fork `git push --set-upstream fork YOUR-FEATURE-TITLE` +1. Create a pull request -We want the code as simple as possible. + +GitHub Flow (https://guides.github.com/introduction/git-handbook/#github) + +We want the code as simple as possible. And please use the present tense and small case for the commit messages and the pull request title. From 3d41014f73f6696da94e46f0139d3005c2a69232 Mon Sep 17 00:00:00 2001 From: Louis Schmieder <dev@louis-schmieder.de> Date: Thu, 16 Jul 2020 21:41:44 +0200 Subject: [PATCH 3/3] add github docs flow --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 339ca0b0..9ec2d50a 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,9 @@ Gitly will support Postgres and MySQL in the future (once V ORM does). ## Contributing -Workflow: +GitHub contributing docs (https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/github-flow) + +Example workflow: 1. Fork the project 1. Add your feature 1. Create a branch `git branch YOUR-FEATURE-TITLE` @@ -54,9 +56,8 @@ Workflow: 1. Commit your features `git commit -m "edit message"` 1. Add your fork as remote `git remote add fork LINK-TO-THE-FORK-REPO` 1. Push it to your fork `git push --set-upstream fork YOUR-FEATURE-TITLE` -1. Create a pull request - +Then create a pull request (https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) GitHub Flow (https://guides.github.com/introduction/git-handbook/#github) We want the code as simple as possible. And please use the present tense and small case for the commit messages and the pull request title.