Skip to content

Commit 69b60e8

Browse files
Move best practives from README to docs directory
1 parent 588a78d commit 69b60e8

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,13 @@ Code style used by AlpineLab in all our projects.
4545

4646
## Best practices
4747

48-
Some conventions are adopted and enforced, in no particular order:
48+
Some conventions are adopted and enforced, but cannot be translated as Rubocop
49+
rules (or are not supposed to). You will find those conventions as Markdown
50+
files in the [`docs`](docs) directory of this project, organized by subject:
4951

50-
1. Developer-specific configuration files must be git-ignored globally, _e.g._:
51-
52-
* `.ruby-{version,gemset}`
53-
* `docker-compose.override.yml`
54-
55-
2. Project-specific configuration files must be git-ignored per project, _e.g._:
56-
57-
* `config/database.yml`
52+
* [File structure and organisation](docs/files.md)
53+
* [Rails-specific conventions](docs/rails.md)
54+
* [HTTP API development guidelines](docs/http-api.md)
5855

5956
## Releases
6057

docs/files.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# File structure and organization
2+
3+
1. Developer-specific configuration files must be git-ignored globally, _e.g._:
4+
5+
* `.ruby-{version,gemset}`
6+
* `docker-compose.override.yml`
7+
8+
2. Project-specific configuration files must be git-ignored per project, _e.g._:
9+
10+
* `config/database.yml`

0 commit comments

Comments
 (0)