Skip to content
This repository has been archived by the owner on Aug 13, 2021. It is now read-only.

[User-Story] naming #66

Open
Eknir opened this issue Feb 11, 2020 · 2 comments
Open

[User-Story] naming #66

Eknir opened this issue Feb 11, 2020 · 2 comments

Comments

@Eknir
Copy link

Eknir commented Feb 11, 2020

Rationale

The SWAP source code is continuously in development. Issues such as (proper) naming, error handling, and logging must be up to high-quality standards, in order to improve the maintainability of the code.

User-Story

As a developer of the Swarm source code, I want the variables and functions to be properly named, such that by just looking at the variable and function names, I intuitively understand what their function is.

Epic links

Stable SWAP

Acceptance criteria

  • Consensus among all Swarm incentives developers about the proposal to update names and a PR which implements this proposal

Requirements

Work estimate

Related Issues

ethersphere/swarm#1822

@santicomp2014
Copy link

santicomp2014 commented Feb 11, 2020

Maybe a simple way of consensus is a poll (form).
On different naming schemes, so we can all agree on it.

Write Guidelines of naming for SWAP

@janos
Copy link
Member

janos commented Feb 11, 2020

When in doubt, it is the best to consult first https://github.com/golang/go/wiki/CodeReviewComments and https://golang.org/doc/effective_go.html.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants