Skip to content

Rewrite files best practices #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michaelbaudino merged 2 commits into from
Oct 9, 2018
Merged

Rewrite files best practices #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3d7a5d
Move best practices from README to docs directory
michaelbaudino Oct 9, 2018
2316bf5
Reword files structure best practices
michaelbaudino Oct 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
18 changes: 18 additions & 0 deletions docs/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy link
Member Author

@michaelbaudino michaelbaudino Oct 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those might not be the official Git documentation, but I find them easier to understand for newcomers, more straight-to-the-point and still reliable enough (even if not official). So I'd keep them, rather than Git man pages, tbh.