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..316e04d --- /dev/null +++ b/docs/files.md @@ -0,0 +1,18 @@ +# File structure and organization + +## Git-ignore'd files + +**Developer-specific** configuration files should be +[git-ignored globally], _e.g._: + +* `.ruby-version` +* `.ruby-gemset` +* `docker-compose.override.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