diff --git a/README.md b/README.md index 34d70f0f..9ec2d50a 100644 --- a/README.md +++ b/README.md @@ -42,3 +42,22 @@ Required dependencies: Gitly will support Postgres and MySQL in the future (once V ORM does).  + + +## Contributing +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` +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` + +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.