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.

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

Determine Conventions #9

Closed
2 of 4 tasks
oliver-pham opened this issue Jan 8, 2022 · 3 comments · Fixed by #11
Closed
2 of 4 tasks

Determine Conventions #9

oliver-pham opened this issue Jan 8, 2022 · 3 comments · Fixed by #11
Assignees
Labels
difficulty:easy Issue that takes 1 - 3 days priority:high Issue that needs urgent feedback/attention question Further information is requested

Comments

@oliver-pham
Copy link
Collaborator

oliver-pham commented Jan 8, 2022

There are conventions to enhance communication, collaboration, and productivity. Before we start developing our project, I think we should decide on a few conventions below:

I think these naming conventions are a great start. Maybe we can use them.

Feel free to create a new issue and suggest a convention for each item. This issue is used for tracking all the conventions to be implemented.

Resources:

@oliver-pham oliver-pham added the question Further information is requested label Jan 8, 2022
@oliver-pham oliver-pham added the priority:high Issue that needs urgent feedback/attention label Jan 8, 2022
@hlavu
Copy link
Collaborator

hlavu commented Jan 9, 2022

I suggest writing all commit messages in the same structure like V + N such as Create sign-in form.
For branch name we can make use of the issue id like issue#id.
About PR desc we should provide what have been done, which packages have been used and a screenshot (if necessary).

@tuanthanh2067
Copy link
Owner

@hlavu Yeah, okay so I'm gonna create a PR about this convention in CONTRIBUTING.md. It will be under docs folder.

@minhhang107
Copy link
Collaborator

For branch name, we should separate new feature and bugfix. We can also use descriptive branch name like: type/issue#-issue-name

eg:
docs/9-determine-conventions (not sure if we need this type or should just put it into feature?)
feature/13-add-landing-page
bugfix/100-fix-button-on-landing-page

@oliver-pham oliver-pham linked a pull request Jan 10, 2022 that will close this issue
@oliver-pham oliver-pham added the difficulty:easy Issue that takes 1 - 3 days label Jan 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty:easy Issue that takes 1 - 3 days priority:high Issue that needs urgent feedback/attention question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants