Skip to content
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.

Sign up for GitHub

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

Jump to bottom

add contributing file #11

Merged
merged 2 commits into from
Jan 15, 2022
Merged

add contributing file #11

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de3b0a3
add contributing file
tuanthanh2067 Jan 9, 2022
fd53f86
docs: change commit message structure
tuanthanh2067 Jan 15, 2022
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
27 changes: 27 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing to Seeksi

## Welcome devs!

Please read through all the information below to learn more about how to create issues, branches, commit messages...

## Issues

Please provide descriptive issues which follow our issue templates.

## Commit messages

Use this structure `Verb + Noun`. For example: `Create sign-in form`.
oliver-pham marked this conversation as resolved.
Show resolved Hide resolved

## Branches

When creating a branch, make sure you our convention for branch name which is `issue#id`. For example: `issue#123` for `123` is the issue number.
oliver-pham marked this conversation as resolved.
Show resolved Hide resolved

## Pull request

Please provide as much information as possible, so that reviewers won't have to spend time on figuring about what the pull request is about,...

A good pull request should include information about what have you done, what you changed, what packages you added, or even a screenshot would be great.

## Code review

After creating a pull request, and you should request a code review from one of the team members **AS SOON AS POSSIBLE**.