Skip to content

Commit

Permalink
Add contribution information
Browse files Browse the repository at this point in the history
  • Loading branch information
undergroundwires committed Feb 10, 2022
1 parent 4a6e343 commit 817c9e7
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
@@ -0,0 +1 @@
github: undergroundwires
8 changes: 7 additions & 1 deletion .gitignore
@@ -1 +1,7 @@
node_modules
# NPM
node_modules

# vscode

.vscode/**/*
!.vscode/extensions.json
6 changes: 6 additions & 0 deletions .vscode/extensions.json
@@ -0,0 +1,6 @@
{
"recommendations": [
"davidanson.vscode-markdownlint",
"timonwong.shellcheck"
]
}
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
@@ -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.
8 changes: 5 additions & 3 deletions README.md
Expand Up @@ -140,9 +140,11 @@ You can also use following scripts individually (check script files for usage, p

## Support

- Give it a star ⭐
- Feel free to use the badge in the `README.md` of repository where you use bump-everywhere:
- (it'll look like: [![Auto-versioned by bump-everywhere](https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true)](https://github.com/undergroundwires/bump-everywhere))
**Sponsor 💕**. Consider one time or recurring donation on [GitHub Sponsors](https://github.com/sponsors/undergroundwires) or [any other way (undrgroundwires.dev/donate)](https://undergroundwires.dev/donate), every penny you leave will help development and maintainance of the project .

**Star 🤩**. If you do cannot do that you can just give it a star ⭐ . It helps me to see that the project is appreciated.

**Badge 📛**. If you use the project, feel free to use the badge in the `README.md` of repository where you use bump-everywhere so we can have larger community that can help improving the project. It would look like [![Auto-versioned by bump-everywhere](https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true)](https://github.com/undergroundwires/bump-everywhere)). You can add following in your markdown file:

```markdown
[![Auto-versioned by bump-everywhere](https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true)](https://github.com/undergroundwires/bump-everywhere)
Expand Down

0 comments on commit 817c9e7

Please sign in to comment.