Skip to content

add contributing workflow #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -42,3 +42,22 @@ Required dependencies:
Gitly will support Postgres and MySQL in the future (once V ORM does).

![](https://user-images.githubusercontent.com/687996/85933714-b195fe80-b8da-11ea-9ddd-09cadc2103e4.png)


## 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.