Skip to content

Commit b721573

Browse files
committed
Initial commit
Initial commit of documentation.
1 parent 1820c74 commit b721573

File tree

1 file changed

+58
-1
lines changed

1 file changed

+58
-1
lines changed

README.md

+58-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,58 @@
1-
# process
1+
# Coderly Handbook
2+
3+
## New incoming task
4+
- Create the task in Asana
5+
- Write a description that is clear. Someone else should be able to get started on the task without needing to ask you any further questions.
6+
7+
## You get assigned a new Asana task
8+
- Make sure the task is clear enough
9+
- Assign a due date for yourself and commit to it
10+
11+
## A task you were assigned isn’t clear enough
12+
- Assign the task to whoever is best suited to clarify the task
13+
- Write question as a comment in the Asana task and reference the person who can answer it (like @JoshSmith)
14+
15+
## You begin work on a new Asana task
16+
- Create a new feature branch like `code start update product photos`
17+
- Make the smallest change possible to get started with the feature and commit
18+
- Create a pull request `code pr`
19+
- Add a link to the Asana task on the first line of the PR description
20+
- Add a link to the Github PR on the first line of the Asana description
21+
22+
## You have some questions for a task
23+
- Assign the task to whoever is best suited to answer the question
24+
- Write question as a comment in the Asana task and reference the person who can answer it (like @JoshSmith)
25+
26+
## You answered someones questions for a task
27+
- Assign the task back to the person who asked you the question
28+
- You need your code to be reviewed
29+
- Assign an `awaiting review` label to your PR
30+
- Assign an `awaiting review` tag to your task and move it to the top of the section. All “awaiting review” tasks should be at the top of the section.
31+
32+
## Daily code review process
33+
- Review all PRs that have the `awaiting review` label
34+
- How to review a PR
35+
- Remove the awaiting review label from Asana and GitHub
36+
- If the code looks good
37+
- Add `reviewed` label to the PR
38+
- Add `reviewed` tag to the Asana task
39+
- If the code needs work and you want to take a look after they make the changes, assign the `needs work` label
40+
- If the code just needs a few changes made and you are fine with them merging without a second review
41+
- Add `reviewed` and `good after changes` labels to the PR
42+
- Add `reviewed` tag to the Asana task
43+
- Add the `reviewed` Asana just
44+
45+
46+
## Tags
47+
Tags in Asana should always be in the following order
48+
49+
### Reviewed
50+
The PR has been reviewed and everything looks good
51+
### Awaiting Review
52+
The PR needs someone to take a look at it for feedback
53+
### Needs Work
54+
This PR needs has some required changes before merging
55+
### Doing Now
56+
This PR is currently being worked on
57+
### Blocked
58+
This PR is currently blocked. The person working on this needs something before he can continue.

0 commit comments

Comments
 (0)