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

General Guide #1

Open
Jood80 opened this issue Mar 15, 2022 · 0 comments
Open

General Guide #1

Jood80 opened this issue Mar 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation Planning

Comments

@Jood80
Copy link
Contributor

Jood80 commented Mar 15, 2022

Reviewing code

  • Every PR must be approved by all the team in order to be merged to the dev branch.
  • Don't resolve a comment on your PR but only comment back (reply), and let the comment writer resolve it

Working on a task

  1. Branch naming:
  • branch names shall follow this style feat/issueNumber-issue-name (e.g. 102-login-page)
  • pick one of those as for the first part of your branch name feat, bugfix, hotfix, refactor
  1. Committing changes:
    • any changes that are not related to the task (issue) or are not mentioned in it will not be accepted (if there is a bug that is making your task fail, open an issue for it and start working on fixing it)
    • make sure to fire npm run lint after finishing your task
    • commits must always be descriptive and must follow the conventions mentioned here
    • every and each commit must relate to the PR number at the end, (e.g feat(login): create login page (#PR_number))
  2. Use of labels and projects
    • once started working on a task label the issue In Progress and move it to the In progress column in its project.
    • label the PR Review Needed if you need it to be reviewed.
    • label the PR In Progress if you still working on it.
    • PRs must be labeled with Changes Requested once a change is requested and once you finished working on a task give it Accepted label.
    • label the PR Completed after it's got into validation and tested successfully and close the issue
    • any Accepted PR can be merged to the dev branch. Only Completed tasks can be merged into master.
    • once a PR or an issue is closed it shall not be reopened. if there exists a bug related to a specific issue that was closed, another issue is to be opened and labeled Bug.
    • if there exists some critical bug that is causing the project to crash an issue with the labels Bug, Urgent, and priority has to be opened
@Jood80 Jood80 added documentation Improvements or additions to documentation Planning labels Mar 15, 2022
@Jood80 Jood80 pinned this issue Mar 15, 2022
@NadiaJalalTamimi NadiaJalalTamimi mentioned this issue May 9, 2022
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Planning
Projects
None yet
Development

No branches or pull requests

1 participant