Skip to content
This repository was archived by the owner on Apr 21, 2024. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (74 loc) · 3.62 KB

CONTRIBUTING.md

File metadata and controls

106 lines (74 loc) · 3.62 KB

Contributing to BashPass-RPM

Your contributions are always welcome, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Bug reports using Github's issues

If you come across a bug, feel free to report it by opening a new issue, and selecting the Bug report template.

Write bug reports with detail, background, and sample code

When you decide to open an issue, please use the appropriate template provided.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • Be specific!
  • Give sample code if you can. Includes sample code that anyone with a base Bash knowledge can understand and run.
  • What you expected would happen
  • What actually happens
  • The version of the software
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Feature requests using Github's issues

We are always open for new feature that could be added, feel free to suggest them by opening a new issue, and selecting the Feature request template.

Code and Documentation Changes

If you're interested in contributing to BashPass-RPM, we welcome both code and documentation changes. Here is what you need to know:

Code Changes

Pull requests are the best way to propose changes to the codebase. To submit a code change, follow these steps:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request.

Use a Consistent Coding Style

To ensure consistency and readability of the codebase, please follow these guidelines when contributing to BashPass-RPM:

  • Indent 4 spaces.
  • Try to keep lines below 100 characters long.
  • Use snake_case for function and variable names.
  • Use Bash built-ins wherever possible.
  • Limit usage of external commands $(cmd).
  • Try not to pipe (|) for everything.
  • Variables must be surrounded by {}.
  • Loops and conditionals should use the (( )) and [[ ]] syntax (where possible).
  • Quote EVERYTHING.

If the test only has one command inside of it; use the compact test syntax. Otherwise the normal if/fi is just fine.

# Bad
if [[ "${var}" ]]; then
    printf '%s\n' "${var}"
fi

# Good
[[ "${var}" ]] && printf '%s\n' "${var}"

# Also good (Use this for longer lines).
[[ "${var}" ]] && \
    printf '%s\n' "${var}"

ShellCheck

For your contribution to be accepted, your changes need to pass ShellCheck.

$ shellcheck bashpass-remote

Note: If you have trouble installing ShellCheck. You can open a pull request on the repo and our GitHub actions will run ShellCheck for you.

Comments

  • Write comments to explain the purpose and functionality of the code, particularly for complex or non-obvious sections.
  • Use inline comments sparingly, and only when necessary to clarify the code.

Creating a Pull Request

When creating a pull request, please ensure that your changes are well-documented and that they are thoroughly tested. We've provided a template you can fill out, and you'll be good to go.

License

By contributing, you agree that your contributions will be licensed under the MIT License.