From b3d7a5d8ce801f02fa62cb15c244a56fc800cc99 Mon Sep 17 00:00:00 2001 From: Michael Baudino Date: Tue, 9 Oct 2018 08:40:44 +0200 Subject: [PATCH 1/2] Move best practices from README to docs directory --- README.md | 15 ++++++--------- docs/files.md | 10 ++++++++++ 2 files changed, 16 insertions(+), 9 deletions(-) create mode 100644 docs/files.md diff --git a/README.md b/README.md index 5255e97..f45b499 100644 --- a/README.md +++ b/README.md @@ -45,16 +45,13 @@ Code style used by AlpineLab in all our projects. ## Best practices -Some conventions are adopted and enforced, in no particular order: +Some conventions are adopted and enforced, but cannot be translated as Rubocop +rules (or are not supposed to). You will find those conventions as Markdown +files in the [`docs`](docs) directory of this project, organized by subject: -1. Developer-specific configuration files must be git-ignored globally, _e.g._: - - * `.ruby-{version,gemset}` - * `docker-compose.override.yml` - -2. Project-specific configuration files must be git-ignored per project, _e.g._: - - * `config/database.yml` +* [File structure and organisation](docs/files.md) +* [Rails-specific conventions](docs/rails.md) +* [HTTP API development guidelines](docs/http-api.md) ## Releases diff --git a/docs/files.md b/docs/files.md new file mode 100644 index 0000000..4ce02d8 --- /dev/null +++ b/docs/files.md @@ -0,0 +1,10 @@ +# File structure and organization + +1. Developer-specific configuration files must be git-ignored globally, _e.g._: + + * `.ruby-{version,gemset}` + * `docker-compose.override.yml` + +2. Project-specific configuration files must be git-ignored per project, _e.g._: + + * `config/database.yml` From 2316bf5dc057adf7e76f66bedd8ead1788eb0740 Mon Sep 17 00:00:00 2001 From: Michael Baudino Date: Tue, 9 Oct 2018 08:52:16 +0200 Subject: [PATCH 2/2] Reword files structure best practices --- docs/files.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/files.md b/docs/files.md index 4ce02d8..316e04d 100644 --- a/docs/files.md +++ b/docs/files.md @@ -1,10 +1,18 @@ # File structure and organization -1. Developer-specific configuration files must be git-ignored globally, _e.g._: +## Git-ignore'd files - * `.ruby-{version,gemset}` - * `docker-compose.override.yml` +**Developer-specific** configuration files should be +[git-ignored globally], _e.g._: -2. Project-specific configuration files must be git-ignored per project, _e.g._: +* `.ruby-version` +* `.ruby-gemset` +* `docker-compose.override.yml` - * `config/database.yml` +**Project-specific** configuration files should be +[git-ignored locally] (_i.e._ per project), _e.g._: + +* `config/database.yml` + +[git-ignored locally]: https://help.github.com/articles/ignoring-files/#create-a-local-gitignore +[git-ignored globally]: https://help.github.com/articles/ignoring-files/#create-a-global-gitignore