We want to encourage other squads to contribute with our templates. It is good that everyone sees these templates as a company thing and not attached to one squad or another. It would be nice to remove the [COREAPI-XXXX] from the PR template as well.

Remember guys, these are only suggestions. I want to encourage people to collaborate more.

Proposed changes

Change the readme text to be more neutral

Checklist

• [ ] Have you written tests for your changes?
• [ ] Have you successfully run tests with your changes locally?
• [ ] Have you lint your code locally prior to submission?

[COREAPI-XXXX]

Proposed changes

Describe your changes briefly and objectively.

• Foo
• Bar
• Baz

Checklist

• [ ] Have you written tests for your changes?
• [ ] Have you successfully run tests with your changes locally?
• [ ] Have you lint your code locally prior to submission?

Proposed changes

• Docker compose file back to root dir to avoid services collision between projects.
• Move setup bash to tools.
• Setup bash create hooks symlink stand of copy.
• Add project rename in setup bash.

Checklist

• [ ] Have you written tests for your changes?
• [ ] Have you successfully run tests with your changes locally?
• [ ] Have you lint your code locally prior to submission?

Proposed changes

Inclusão de uma action para verificar os guidelines do projeto. Inclusão de uma action para execução do sonar. Pequena correção de nome de projeto no arquivo de setup devido ao projeto ter sido renomeado.

Checklist

• [ ] Have you written tests for your changes?
• [ ] Have you successfully run tests with your changes locally?
• [ ] Have you lint your code locally prior to submission?

Proposed changes

• Add a logger interface to allow mocking for unit tests;
• Improve the pre-commit hook to run go vet for whole packages instead of single files (avoid import errors);
• Improve directory structure and file names;
• Add an example of mock at health_check_handler_test.go;
• Move go funk to direct dependecies (closes https://github.com/madeiramadeirabr/template-service-go/issues/24).

Checklist

• [x] Have you written tests for your changes?
• [x] Have you successfully run tests with your changes locally?
• [x] Have you lint your code locally prior to submission?

Proposed changes

• Remove common utils (goodbye Fck() 🙁).

Checklist

• [ ] Have you written tests for your changes?
• [ ] Have you successfully run tests with your changes locally?
• [ ] Have you lint your code locally prior to submission?

Proposed changes

• Pre-commit hook exclude deleted files when filter changes.

Checklist

• [ ] Have you written tests for your changes?
• [ ] Have you successfully run tests with your changes locally?
• [ ] Have you lint your code locally prior to submission?

Proposed changes

• Add inline JSON message for non-development logs;
• Fix health check directory name;
• Improve README.

Checklist

• [x] Have you written tests for your changes?
• [x] Have you successfully run tests with your changes locally?
• [x] Have you lint your code locally prior to submission?

Proposed changes

Necessary modification to comply with MMRFC1.

Checklist

• [ ] Have you written tests for your changes?
• [x] Have you successfully run tests with your changes locally?
• [x] Have you lint your code locally prior to submission?

Proposed changes

Describe your changes briefly and objectively.

• Added error handling for routes
• Routes now catch panic error

example :

app.Get("/", func(c *fiber.Ctx) error {
    // 503 Service Unavailable
    return fiber.ErrServiceUnavailable

    // 503 On vacation!
    return fiber.NewError(fiber.StatusServiceUnavailable, "On vacation!")
})

or

app.Get("/", func(c *fiber.Ctx) error {
        panic("This panic is caught by fiber")
    })

Checklist

• [ ] Have you written tests for your changes?
• [x] Have you successfully run tests with your changes locally?
• [x] Have you lint your code locally prior to submission?

Proposed changes

• Alive endpoint is used for the CloudOps team to set up the project infrastructure;
• I've also sent the config pointer to the health check handler to improve our health check example.

Checklist

• [ ] Have you written tests for your changes?
• [x] Have you successfully run tests with your changes locally?
• [x] Have you lint your code locally prior to submission?

[COREAPI-XXXX]

Proposed changes

Describe your changes briefly and objectively.

• Foo
• Bar
• Baz

Checklist

• [ ] Have you written tests for your changes?
• [ ] Have you successfully run tests with your changes locally?
• [ ] Have you lint your code locally prior to submission?

Esta solicitação pull adiciona um arquivo de metadados de entidade Backstage a este repositório para que o componente possa ser adicionado ao catálogo de software da MadeiraMadeira no Portal DX.

Depois que essa solicitação pull for mesclada, o componente ficará disponível.

Sinta-se à vontade para fazer alterações no arquivo. Para mais informações, leia a documentação com as orientações específicas em Arquivo de Configuração no Confluence do DX Team.

It would be neat if we had a CLI for scaffold generation using this template. Developers could simply

$ fooCli <project_name>

and it automatically creates a project_name directory with the template in it.

Nice to have: the CLI could also automatically create a GitHub repo with all CI/CD pipeline setup.

The template project should have a basic setup for automatic Swagger docs generation, that can be used by projects later.

Idea: there's a handy lib called Swag that could help achieving this using godoc (you simply comment the handler functions and the Swagger docs gets automatically generated). This can be added to a Makefile or even the CI/CD pipeline.

Test tables are an elegant way of reducing the amount of duplicated code when unit testing. The template project could have some test table examples.

func TestFoo(t *testing.T) {
	testTable := []struct {
		testName string
		expectedErr error
		// add more variables to the test case here
	} {
		{
			testName: "it should foo bar baz",
			expectedErr: errors.New("foo"),
		},
	}
	for _, testCase := range testTable {
		t.Run(testCase.testName, func(t *testing.T) {
			// Arrange
			
			// Act
			
			// Assert
		})
	}
}

Notice that test tables don't completely replace normal test cases. There are moments we simply should not use test tables.