Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4a6e343
commit 817c9e7
Showing
5 changed files
with
70 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
github: undergroundwires |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,7 @@ | ||
node_modules | ||
# NPM | ||
node_modules | ||
|
||
# vscode | ||
|
||
.vscode/**/* | ||
!.vscode/extensions.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"recommendations": [ | ||
"davidanson.vscode-markdownlint", | ||
"timonwong.shellcheck" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Contributing to bump-everywhere | ||
|
||
First off, thanks for taking the time to contribute! 💓 | ||
|
||
You can contribute by: | ||
|
||
- creating pull requests, | ||
- creating or responding to [issues](https://github.com/undergroundwires/bump-everywhere/issues), | ||
- supporting the development and maintainance by [sponsoring me on GitHub](https://github.com/sponsors/undergroundwires) with a single time donation or reccuring donations, see more options in [undergroundwires.dev/donate](https://undergroundwires.dev/donate/), | ||
- giving the project a star, | ||
- or adding a badge in a project you use bump-everywhere, see [support](./README.md#support). | ||
|
||
## Development environment | ||
|
||
If you're using visual studio code, [recommended extensions](./.vscode/extensions.json) would install useful linters and extensions. | ||
|
||
## Style guide | ||
|
||
- Do not introduce any TODO comments, fix them or do not introduce the change. | ||
- Use common sense, simpler is better. | ||
|
||
### Shell scripting | ||
|
||
- Use [ShellCheck](https://www.shellcheck.net/) to lint your code. | ||
- Always check for return values. | ||
- Declare function-specific variables as `local`. | ||
- Declare variables as readonly whenever possible. | ||
- E.g. `local -r ..`, `declare -r ..` or `readonly ..`. | ||
- Send all errors messages to stderr. | ||
- E.g. `>&2 echo 'Error!'`. | ||
- Use always `#!/usr/bin/env bash` shebang. | ||
- Wrap long lines. | ||
- Use `[[ … ]]` over `[ … ]`, `test`. | ||
- Avoid eval at all cost. | ||
|
||
#### Naming conventions | ||
|
||
**Source file names:** | ||
|
||
- Use `kebab-case.sh`. | ||
- For tests, use `.test` suffix such as `<system-under-test>.test.sh`. | ||
|
||
**Function names:** | ||
|
||
- Use snake_case. E.g. `my_func() { ... }` | ||
- Prefix functions in files that others files source with a scope name and `::`. E.g. `utilities::has_value() { }`. | ||
|
||
**Variable names**: | ||
|
||
- Use snake_case for local variables. | ||
- Use ALL_CAPS_SEPARATED_WITH_UNDERSCORES for constant and environment variable names. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters