chore(docs): add code guidelines

[Pantani]

Description

Add code guidelines so we can review and create this document together.

[codecov]

Codecov Report

Merging #1819 (0b7d903) into main (e8833fa) will decrease coverage by 4.90%.
The diff coverage is n/a.

❗ Current head 0b7d903 differs from pull request most recent head e798a28. Consider uploading reports for the commit e798a28 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1819      +/-   ##
==========================================
- Coverage   79.93%   75.02%   -4.91%     
==========================================
  Files          23       34      +11     
  Lines        1540     1862     +322     
==========================================
+ Hits         1231     1397     +166     
- Misses        260      402     +142     
- Partials       49       63      +14     

[okwme]

One question about the test command already including the hermes build but otherwise so great to see a doc like this!

There are some redundancies with the current https://github.com/cosmos/gaia/blob/main/CONTRIBUTING.md. This will be included in the hub.cosmos.network as it's part of the doc directory, should it link to the other file or the other way around? should we consider merging the content or use this one for website rendered audiences versus github markdown audiences?

[yaruwangway]

can we also have a guide for writing testing code, including test file naming, structure etc

[Pantani]

One question about the test command already including the hermes build but otherwise so great to see a doc like this!

There are some redundancies with the current https://github.com/cosmos/gaia/blob/main/CONTRIBUTING.md. This will be included in the hub.cosmos.network as it's part of the doc directory, should it link to the other file or the other way around? should we consider merging the content or use this one for website rendered audiences versus github markdown audiences?

Yes, sure!! Let's merge them. It's nice to have clear documentation in one place and not massive documentation for everyone to read quickly; WDYT?

[Pantani]

• add semantic PR title guidelines
• add branch name guidelines
• add gitflow guidelines
• add commit description guideline

[Pantani]

• Avoid writing directly in the stdout. Eg:

gaia/app/sim_test.go

Line 111 in fb95f50

fmt.Printf(

[Pantani]

• avoid panic
• handle error on the top level

[Pantani]

• use subtests

[yaruwangway]

shall we create a types/errors/errors.go to collect all err types together or put errors in each file where they were used?

[Pantani]

I think we can follow the current pattern and keep it inside the types package for each module, but we can create a pkg/errors for more generic errors.

[yaruwangway]

can we add

avoid "+" for frequent string concatenation

• bad

func strConcat(n int, str string) string {
	s := ""
	for i := 0; i < n; i++ {
		s += str
	}

	return s
}

• good
  a better option is strings.Builder or []byte

func strConcat(n int, str string) string {
	b := []byte{}
	for i := 0; i < n; i++ {
		buf = append(buf, str...)
	}

	return string(b)
}

In golang, string is immutable. when use "+", every time, there has to be a new memory allocation. For []byte, the memory of the slice []byte is allocated in multiples.

[Pantani]

Yes, this is a very nice one! sometimes the + can be more performative. But definitely is not so clear to read

[yaruwangway]

can we add a section about importable and unimportable struct field and funcs ?

[okwme]

• extract relevant parts of contibuting.md and include in this pr and remove from the other

[okwme]

• add instructions from upgrade test here to run manually
  They're here: fix bank migration in upgrade handler #1892 (comment)

[Pantani]

• add instructions from upgrade test here to run manually

can you share this info for I can add?

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information