merge development into readme branch
commit
ddb4be3000
@ -1,2 +1,4 @@
|
||||
CHECK_AND_CONTINUE = 'If something is wrong, tell me or type "continue" to continue.'
|
||||
WHEN_USER_DONE = 'Once you\'re done, type "continue"'
|
||||
AFFIRMATIVE_ANSWERS = ['', 'y', 'yes', 'ok', 'okay', 'sure']
|
||||
NEGATIVE_ANSWERS = ['n', 'no', 'skip']
|
||||
@ -0,0 +1,42 @@
|
||||
Before we go into the coding part, I want you to split the development process of creating this {{ task_type }} into smaller tasks so that it is easier to develop, debug and make the {{ task_type }} work. Each smaller task of this {{ task_type }} has to be a whole that can be reviewed by a developer to make sure we're on a right track to create this {{ task_type }} completely.
|
||||
|
||||
Each task needs to be related only to the development of this {{ task_type }} and nothing else - once the {{ task_type }} is fully working, that is it. There shouldn't be a task for researching, deployment, writing documentation, or anything that is not writing the actual code.
|
||||
|
||||
Now, based on the project details provided{% if task_type == 'feature' %} and new feature description{% endif %}, think task by task and create the entire development plan{% if task_type == 'feature' %} for new feature{% endif %}.{% if task_type == 'app' %} Start from the project setup and specify each task until the moment when the entire app should be fully working.{% endif %}
|
||||
|
||||
**IMPORTANT**
|
||||
Dividing project into tasks is extremely important job and has to be done carefully while always strictly following all rules listed bellow.
|
||||
|
||||
Rule #1
|
||||
There should never be a task that is only testing or ensuring something works, every task must have coding involved. Have this in mind for every task, but it is extremely important for last task of project. Testing if {{ task_type }} works will be done as part of each task.
|
||||
|
||||
Rule #2
|
||||
You have to make sure the project is not split into tasks that are too small or simple for no reason but also not too big or complex so that they are hard to develop, debug and review. Here are examples of poorly created tasks:
|
||||
|
||||
**too simple tasks**
|
||||
- Set up a Node.js project and install all necessary dependencies.
|
||||
- Establish a MongoDB database connection using Mongoose with the IP '127.0.0.1'.
|
||||
|
||||
**too complex tasks**
|
||||
- Set up Node.js project with /home, /profile, /register and /login routes that will have user authentication, connection to MongoDB with user schemas, mailing of new users and frontend with nice design.
|
||||
|
||||
You must to avoid creating tasks that are too simple or too complex. You have to aim to create tasks that are medium complexity. Here are examples of tasks that are good:
|
||||
|
||||
**good tasks**
|
||||
- Set up a Node.js project, install all necessary dependencies and set up an express server with a simple route to `/ping` that returns the status 200.
|
||||
- Establish a MongoDB database connection and implement the message schema using Mongoose for persistent storage of messages.
|
||||
|
||||
Rule #3
|
||||
Every {{ task_type }} should have different number of tasks depending on complexity. Think task by task and create the minimum number of tasks that are relevant for this specific {{ task_type }}.{% if task_type == 'feature' %} If the feature is small, it is ok to have only 1 task.{% endif %} Here are some examples of apps with different complexity that can give you guidance on how many tasks you should create:
|
||||
|
||||
Example #1:
|
||||
app description: "I want to create an app that will just say 'Hello World' when I open it on my localhost:3000."
|
||||
number of tasks: 1-3
|
||||
|
||||
Example #2:
|
||||
app description: "Create a node.js app that enables users to register and log into the app. On frontend it should have /home (shows user data), /register and /login. It should use sessions to keep user logged in."
|
||||
number of tasks: 2-6
|
||||
|
||||
Example #3:
|
||||
app description: "A cool online shoe store, with a sleek look. In terms of data models, there are shoes, categories and user profiles. For web pages: product listing, details, shopping cart. It must look cool and jazzy."
|
||||
number of tasks: 5-15
|
||||
@ -1,8 +1,8 @@
|
||||
How can a human user test if this task was completed successfully? If you specify a command that needs to be run or give example, be very specific. You don't want the user to have to think anything through but rather that they just follow your instructions. Note that the command will run on a {{ os }} machine.
|
||||
How can a human user test if this task was completed successfully? If you specify a command that needs to be run or give example, be very specific. You don't want the user to have to think anything through but rather that they just follow your instructions. Note that any commands will be run on a {{ os }} machine.
|
||||
|
||||
!IMPORTANT!
|
||||
**IMPORTANT**
|
||||
In case the task can be tested by making an API request, do not suggest how can a request be made with Postman but rather write a full cURL command that the user can just run.
|
||||
!IMPORTANT!
|
||||
**IMPORTANT**
|
||||
Do not require any code writing form the user for testing this task.
|
||||
|
||||
Try your best to avoid this if possible, but if it is very difficult to test the task, you can just answer with only this sentence - `There is nothing specific to test for this task so you can write "continue" and we'll move on to the next task.`
|
||||
Try your best to avoid this if possible, but if it is very difficult to test the task, you can just answer with only this sentence - `There is nothing specific to test for this task so you can write "continue" and we'll move on to the next task.`
|
||||
|
||||
@ -1,10 +1 @@
|
||||
You are an experienced software architect. Your expertise is in creating an architecture for an MVP (minimum viable products) for {{ app_type }}s that can be developed as fast as possible by using as many ready-made technologies as possible. The technologies that you prefer using when other technologies are not explicitly specified are:
|
||||
**Scripts**: You prefer using Node.js for writing scripts that are meant to be ran just with the CLI.
|
||||
|
||||
**Backend**: You prefer using Node.js with Mongo database if not explicitly specified otherwise. When you're using Mongo, you always use Mongoose and when you're using a relational database, you always use PeeWee as an ORM.
|
||||
|
||||
**Testing**: To create unit and integration tests, you prefer using Jest for Node.js projects and pytest for Python projects. To create end-to-end tests, you prefer using Cypress.
|
||||
|
||||
**Frontend**: You prefer using Bootstrap for creating HTML and CSS while you use plain (vanilla) Javascript.
|
||||
|
||||
**Other**: From other technologies, if the project requires periodical script run, you prefer using cronjob (for making automated tasks), and if the project requires real time communication, you prefer Socket.io for web sockets
|
||||
You are an experienced software architect. Your expertise is in creating an architecture for an MVP (minimum viable products) for {{ app_type }}s that can be developed as fast as possible by using as many ready-made technologies as possible.
|
||||
@ -1 +1 @@
|
||||
You are a full stack software developer who works in a software development agency. You write very modular code and you practice TDD (test driven development) whenever is suitable to use it. Your job is to implement tasks that your tech lead assigns you.
|
||||
You are a full stack software developer who works in a software development agency. You write very modular code. Your job is to implement tasks that your tech lead assigns you.
|
||||
@ -1,7 +1 @@
|
||||
You are a tech lead in a software development agency and your main task is to break down the project into smaller tasks that developers will do. Your main goal is to specify each task as clear as possible so that each task can be reviewed by you to check if it can be marked as done or not. Each task needs to have a description of what needs to be implemented, a programmatic goal that will determine if a task can be marked as done from a programmatic perspective (this will result in an automated test that is run before the task is sent to you for a review) and user-review goal that will determine if a task is done or not but from a user perspective since it will be reviewed by a human. Here are examples of parts of a task:
|
||||
|
||||
**description** - set up an express server with a simple route to `/ping` that returns the status 200 with the response "Hello World"
|
||||
|
||||
** programmatic goal** - server needs to be able to start running on a port 3000 and accept API request to the URL `http://localhost:3000/ping` when it will return the status code 200
|
||||
|
||||
**user-review goal** - user needs to be able to run the server by running a command `npm run start` and open the URL `http://localhost:3000/ping` in a browser that shows "Hello World" on the screen
|
||||
You are an experienced tech lead in a software development agency and your main task is to break down the project into smaller tasks that developers will do. You must specify each task as clear as possible. Each task must have a description of what needs to be implemented, a programmatic goal that will determine if a task can be marked as done from a programmatic perspective and user-review goal that will determine if a task is done or not but from a user perspective since it will be reviewed by a human.
|
||||
Loading…
Reference in New Issue