docs: move coding conventions into contributing.md #1751
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
PR Structure
otherwise).
services/friendbot
, orall
ordoc
if the changes are broad or impact manypackages.
Thoroughness
This PR adds tests for the most critical parts of the new functionality or fixes.I've updated any docs (developer docs,.md
files, etc... affected by this change). Take a look in the
docs
folder for a given service,like this one.
Release planning
I've updated the relevant CHANGELOG (here for Horizon) ifneeded with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
Summary
Move Go coding conventions from the README.md into the CONTRIBUTING.md file which discusses other requirements for code contributed.
Goal and scope
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.
Summary of changes
README.md
toCONTRIBUTING.md
.Known limitations & issues
N/A
What shouldn't be reviewed
N/A