General Guide
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
## **Reviewing code**
- Every `PR` must be approved by all the team in order to be merged
- **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 `issueNumber-issue-description` (**e.g.** `102-login-page`)
2. **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)
- commits must always be descriptive and with appropriate length (neither too long nor too short)
- every and each commit must relate to the issue at the end
3. **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 `awaiting review` if you need it to be reviewed
- label the PR `in progress` if you still working on it
- `PR`s must be labeled with `changes requested` once a change is requested
- once finished working on a task and got approved
- label the PR `done` before merging it
- label the issue `done` and move it to the done column in its project
- close the issue
4. **closed issues and PRs**
- 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 is to be opened
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the General Guide text in this issue; no repository file or documentation entry point is identified. Clarify whether the guide should be added or revised, where it belongs, and what specific content is expected before making a change.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100