Context
During the user interviews, we noticed there is a lot of variance between the templates of each language, and there are some issues with the templates as a whole. Namely, we need to...
- Effectively highlight where the developer inserts their code (//CAN'T MISS COMMENT + Method at the top)
- Make sure the code is effectively commented to assist in developer's understanding of said code
- Make sure the template returns some value ("Hello World!" + message payload) when it is pinged
Story
As Deandra the Developer
I want to better understand how func templates work
So that I can better leverage the templates for my personal needs
Acceptance Criteria
GIVEN I have created a new func project
WHEN I inspect the "main" file (func.py. index.js, handler.go)
THEN I see that the method for handling incoming data is listed as the first method
AND THEN I see a comment within the method which makes it clear where I would put my business logic
The comment within the method should be something to the effect of: //YOUR CODE GOES HERE
GIVEN I have created a new func project
WHEN I inspect the "main" file (func.py. index.js, handler.go)
THEN I see that each method within the "main" file is effectively commented
AND THEN I see that each line is commented with an explanation of what that line does
GIVEN I have created a new func project
AND GIVEN I have built and am currently running the project without any changes
WHEN I invoke the endpoint where the function is running locally using `func invoke`
THEN I see that the currently running function has returned the raw data which was sent to it
AND THEN on a new line, I see that the method returns "Hello from func!"
(Removed from acceptance criteria)
GIVEN I have created a new func project
WHEN I use tools appropriate for the runtime to run tests on a project
THEN I can successfully execute unit tests on my function
Context
During the user interviews, we noticed there is a lot of variance between the templates of each language, and there are some issues with the templates as a whole. Namely, we need to...
Story
As Deandra the Developer
I want to better understand how func templates work
So that I can better leverage the templates for my personal needs
Acceptance Criteria
The comment within the method should be something to the effect of:
//YOUR CODE GOES HEREAND THEN on a new line, I see that the method returns "Hello from func!"(Removed from acceptance criteria)