Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/future-architect/coding-standards

A coding standards for enterprise system
https://github.com/future-architect/coding-standards

coding-guidelines coding-standard coding-standards coding-style coding-styles codingstandard enterprise java java11 java8 sql

Last synced: about 1 hour ago
JSON representation

A coding standards for enterprise system

Host: GitHub
URL: https://github.com/future-architect/coding-standards
Owner: future-architect
License: cc-by-4.0
Created: 2016-08-18T09:34:06.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-10-09T09:48:24.000Z (4 months ago)
Last Synced: 2024-10-13T04:21:08.314Z (4 months ago)
Topics: coding-guidelines, coding-standard, coding-standards, coding-style, coding-styles, codingstandard, enterprise, java, java11, java8, sql
Language: JavaScript
Homepage: https://future-architect.github.io/coding-standards/
Size: 6.3 MB
Stars: 87
Watchers: 18
Forks: 37
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Future Enterprise Coding Standards

フューチャー株式会社が作成するエンタープライズ領域に特化したコーディング規約

[![GitHub last commit](https://img.shields.io/github/last-commit/future-architect/coding-standards.svg)](https://github.com/future-architect/coding-standards)

[![GitHub stars](https://img.shields.io/github/stars/future-architect/coding-standards.svg?style=social&label=Stars&logo=github)](https://github.com/future-architect/coding-standards/stargazers)

## Features

### Readability

ソースコードの可読性を高く保つことで、保守性・拡張性の高いソフトウェアを作ることができます。 しかし、可読性の指標は複数あり、デベロッパーごとに判断がブレ、それぞれのスタイルで記述すると、ソフトウェア全体で見たときの可読性が下がってしまいます。 本コーディング規約は、コーディング時の判断のブレを防ぎます。

### Enterprise

エンタープライズ領域では、社員・パートナーの方々を合わせて、数百人が同時に開発することも珍しくありません。 ちょっとした悩み、失敗も、人数が集まれば大変なコスト・リスクになります。 誰もが引っかかる落とし穴、悩みの種をあらかじめ排除します。

### Performance

時に読みやすいソースコードはパフォーマンス劣化を招くことがあります。 しかし、常にパフォーマンスを優先したソースコードは人間の読めないソースコードになりがちです。 今、書こうとしているソースコードが、どの程度のパフォーマンスになるのか、指標を示すことで、ソフトウェア開発プロジェクトごとに最適なソースコードを選択することができます。

## Coding Standards

| No  | コンテンツ                                                         |

| --- | ------------------------------------------------------------------ |

| 1   | [Java コーディング規約](./documents/forJava/)                      |

| 2   | [SQL コーディング規約](./documents/forSQL/)                        |

| 3   | [AWS インフラリソース命名規約](./documents/forAWSResource/)        |

| 4   | [OpenAPI Specification 規約](./documents/forOpenAPISpecification/) |

| 5   | [Gitブランチフロー規約](./documents/forGitBranch/)                 |

---

> 他の開発言語のコーディング規約も順次作成中です

---

## License

[![CC-By-4.0](https://licensebuttons.net/l/by/4.0/88x31.png)](https://creativecommons.org/licenses/by/4.0/deed.ja)