gchq / gchq/sleeper

Document naming conventions

Open
#7,001 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

Our coding conventions document doesn't currently say anything about naming. We'd like to document the common naming styles in the project.

We can include an explanation about static constructor methods. We usually use a name starting with "from", or "create" to match the AWS SDK clients.

We can include an explanation of SerDe classes for serialisation/deserialisation.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.