Skip to content

Commit 79de7e0

Browse files
docs: move coding conventions into contributing.md (#1751)
Move Go coding conventions from the README.md into the CONTRIBUTING.md file which discusses other requirements for code contributed. I'm in the process of adding a developing document that includes finer details about how to do things like add dependencies, update them, remove them, as part of the previous work switching to Modules (#1634). I noticed during that work that this section is in the projects readme but is primarily listing more things that someone contributing should be thinking about, and not so much someone who is browsing or importing the repository. It makes more sense for this to live in the contributing document.
1 parent 7b83a49 commit 79de7e0

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,8 @@ Check out the [Stellar Contribution Guide](https://github.com/stellar/docs/blob/
2424

2525
* Use `gofmt` or preferably `goimports` to format code
2626
* Follow [Effective Go](https://golang.org/doc/effective_go.html) and [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
27+
28+
### Go Coding conventions
29+
30+
- Always document exported package elements: vars, consts, funcs, types, etc.
31+
- Tests are better than no tests.

README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,6 @@ Generally, file contents are sorted by exported/unexported, then declaration typ
6565

6666
Often, we provide test packages that aid in the creation of tests that interact with our other packages. For example, the `support/db` package has the `support/db/dbtest` package underneath it that contains elements that make it easier to test code that accesses a SQL database. We've found that this pattern of having a separate test package maximizes flexibility and simplifies package dependencies.
6767

68+
### Contributing
6869

69-
## Coding conventions
70-
71-
- Always document exported package elements: vars, consts, funcs, types, etc.
72-
- Tests are better than no tests.
70+
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

0 commit comments

Comments
 (0)