Skip to content

Commit

Permalink
feat: setup the project (#1)
Browse files Browse the repository at this point in the history
* style: add editor config

* docs: add folders

* feat: add folders

* ci: add config
  • Loading branch information
alexfalkowski authored May 18, 2022
1 parent 9f049a3 commit ee08b22
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
version: 2.1

jobs:
build:
docker:
- image: alexfalkowski/go:1.18
steps:
- checkout
- run: make specs
resource_class: large
release:
docker:
- image: alexfalkowski/release:2.0
steps:
- checkout
- run: release

workflows:
bin:
jobs:
- build
- release:
context: gh
requires:
- build
filters:
branches:
only: master
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
root = true

[*]
charset = utf-8
end_of_line = lf
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 2

[Makefile]
indent_style = tab
indent_size = 8

[*.go]
indent_style = tab
indent_size = 4
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Run all specs
specs:
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,16 @@
# bin
A place where common commands live.

A place for common executables.

## Rationale

After some considerable amount of time one starts to repeat themselves around projects (maybe it is just me). Rather than keep duplicating the efforts, we should standardize them.

## Directories

We will break these executables into higher level categories. These will be as follows:

| Folder | Description |
|---------|---------------------------------------------------------------------|
| Quality | Anything related to style, performance, security, reliability, etc. |
| Build | Any tool to manage and organize builds. |
Empty file added build/.keep
Empty file.
Empty file added quality/.keep
Empty file.

0 comments on commit ee08b22

Please sign in to comment.